Open
Description
styling rules
- sentence case Sentence-case all titles for consistency #161
- no "click here" Change "click here" to more actionable items for URLs #1073
- international (common) english
- "Arabica Devnet" or "Arabica devnet"? f9944ac - use linter to check these
- “Bridge Node” or “bridge node”? - both lowercase
- don’t say “please”
- no duplicate headings
- "Coffee Beta" network
- i.e. or e.g. not i.e. or e.g.
- celestia-app not
celestia-app
- order of tabs should be: Coffee Beta, Mocha, Arabica
- use placeholders as
<flag_name>
not<flag-name>
or<flag name>
how to update docs
- run automation
- if chain-id breaking update, update chain-id. search for it to be sure
- read through release notes to modify docs for any breaking changes’
- https://www.loom.com/share/0d6897939b654b60b766887b37f86790
documentation requirements for software
- proof that it works: passing CI checks, manual test, link to block explorer, rough instructions for how to run the software