docs
docs copied to clipboard
add "docs standards" guide to readme
styling rules
- sentence case https://github.com/celestiaorg/docs/issues/161
- no "click here" https://github.com/celestiaorg/docs/issues/1073
- international (common) english
- "Arabica Devnet" or "Arabica devnet"? https://github.com/celestiaorg/docs/commit/f9944ac47023f8e6ed365ab9283697ea9b49abc9 - 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
- [ ] https://github.com/celestiaorg/docs/pull/857/files#diff-7c3322aa40bebbde7be394c354f900d6b5606eabbd03ac0d661f7565fcadcb70
- [ ] 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
This is literally a chatGPT run of the entire doc section
Can be added to readme