new-docs icon indicating copy to clipboard operation
new-docs copied to clipboard

Documentation Wishlist Mega-Issue

Open Shaptic opened this issue 4 years ago • 1 comments

This is a potpourri of enhancements, improvements, fixes, etc. both large and small that are better off existing in a shared, collaborative space rather than the ephemeral notes and snippets scattered around desks everywhere.

Tiny Fixes

Smaller Items

  • [x] A description of POST /transactions (i.e. when you click it in the right-hand list) is missing in the API Reference [#366].
  • [x] Check if other resources have broken links (this should be scriptable! or at least script-assisted) [#414, #418]
  • [x] Remove Watcher references to the Run a Core Node tutorial now that they're obsolete after Horizon 2.0 [#367, #413].
  • [x] After removing, add note that Watcher is a deprecated concept rather than nuke its existence from the documentation entirely (this would help in the case of e.g. #376) [#413].
  • [x] Ensure that the API reference is up-to-date and accurately reflects the current API
    • [x] Issue: the payments page doesn't actually have a proper payments response in the example JSON (see e.g. an type=account_merge operation being included) [#419]
    • [x] Issue: some of the API examples weren't even valid JSON [#402]
  • [x] Clarify that fee-bump transactions should be submitted just like normal ones [#368].
  • [x] Cross-reference the error-handling guide everywhere it's applicable in a nice <Alert> box, including both the transaction and fees glossary pages, as well as all of the tutorials [#455].
  • [ ] Clarify that a low_fee error has a recommendation for the fee bump amount in its fee_charged value (already mentioned here, but could also be mentioned here).
  • [x] Add Clawback enabled flag to Control Access to an Asset page [#456].

Larger Items

  • [x] A tutorial on pooled accounts, describing why & how they're used, with code examples demonstrating the simplicity of the implementation [#379]
  • [ ] A section of the docs walking through the client-side execution of payment SEPs (6, 24, 31)
  • [ ] Clarify how CAP-18 changes account authorization flags (crucially, isAuth => isAuthToMaintain).

True "Wish"list

Anyone should feel free to take any of these up if they feel like contributing to the docs!

Shaptic avatar Mar 23 '21 05:03 Shaptic

I'd like to emphasize the need for a tutorial regarding custodial/pooled accounts. We're getting a lot of inquiries on these.

tomerweller avatar Mar 24 '21 20:03 tomerweller