Before committing changes
Run the following command in the doc
directory:
Why tho? ಠ╭╮ಠ
After a Starlight upgrade
Nouns
Common nouns
- account servicing entity
- payment pointer
- wallet address
Proper nouns
- Interledger
- Interledger Protocol (can be abbreviated to ILP after first use on a page)
- Open Payments (always spell out, do not abbreviate as OP)
- Rafiki
- Web Monetization (always spell out, do not abbreviate as WM)
Spellings
Open Payments
Spell as two words, not one (OpenPayments).
Prettier notes
Why do we have to run npx prettier . --write
before we commit our changes?
- Because the Open Payments project demands it. We think it’s because of the way the API specs are integrated with the docs.
- It ensures all outputted code conforms to a consistent style. - prettier docs
For example, if you’re like Melissa and add italics in markdown using single asterisks:
Prettier automatically converts the asterisk set to underscores: