Skip to content

docs/concepts/memos.md - large clean-up

koitsu requested to merge koitsu/thornode:docs-memos-cleanup into develop

This commit makes a large number of various changes to docs/concepts/memos.md. The changes are so many that I felt putting them in the PR Description would be better.

All these changes were checked/reviewed locally using mdBook. For my commentary/details on dealing with that, see Discord thread: https://discord.com/channels/838986635756044328/1196947336820174858

  • Overview
    • General stuff
      • Capitalisation fixes
      • Move "all memos are listed here" stuff to bottom of section
      • Mention scientific notation syntax + add link to relevant doc
      • Mention THORName + add link to relevant doc
      • Change link to GitLab code defining memos to the file itself, since lines in file will change unless referring to a specific commit
    • Memo Size Limits
      • Capitalisation fixes
    • Dust Thresholds
      • New section that references the relevant THORNode docs section talking about them
  • Format
    • Simplify; put things on same line, a la info a few paragraphs up
  • Permitted Functions
    • Shorten anchor links (no need to include memos.md in hyperlinks)
  • All memos
    • Use word "and" not ampersand character; ampersand breaks anchor links (mdBook bug), and use of & does not fix it
    • Add descriptions right after all section headers
    • Make memo headlines consistent; they should show "longest syntax", e.g. where all optional fields are mentioned
    • Minimise inline hyperlinks for everything; instead we have sections that already link to these
    • Try hard to make all the formatting 100% consistent. This includes spacing, phrasing, capitalisation, as well as punctuation. A common one are lines that end in period
    • Try to shorten some of the table widths if at all possible
    • Fix 'affiliate address' links (link really describes fees)
    • Use — ( — ) to separate examples and descriptions
    • Improve everything in Examples sections. Particularly, try to demonstrate all memo syntax variations whilst also demonstrating other memo features
    • Any other unique details I will describe on a per-memo basis below
  • Swap
    • Remove duplicate header/memo section at top
    • Mention DEX aggregator memo variation + provide link
  • Deposit Savers
    • Move admonish info to end of section
  • Withdraw Savers
    • Remove dust threshold example values -- refer to Dust Threshold section instead
    • Add admonish info area mentioning that withdrawals can be done memoless + provide link
  • Withdraw Liquidity
    • Header memo should be WITHDRAW not WD
  • BOND, UNBOUND and LEAVE
    • Remove "Anytime" on BOND handler; I don't know what was meant by this to begin with
  • NOOP
    • Fix memo definition (not sure why was using backslashes)
    • admonish section should be type "danger" due to loss of funds
  • Refunds
    • Should be a header2 section not a header3 section
  • Other Internal Memos
    • Should be a header2 section not a header3 section
    • Update all the other memos based on what's in the THORChain code. Some were wrong, others were long gone, etc...
    • Sort list of memos

Merge request reports