New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add "docs standards" guide to readme #1076

Open

6 tasks

Tracked by

jcstein opened this issue Sep 19, 2023 · 2 comments

Open

6 tasks

Tracked by

add "docs standards" guide to readme #1076

jcstein opened this issue Sep 19, 2023 · 2 comments

Assignees

Labels

documentation good first issue help wanted

Member

jcstein commented Sep 19, 2023 •

edited

Loading

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
- 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

The text was updated successfully, but these errors were encountered:

jcstein self-assigned this

jcstein mentioned this issue

chore: no "click here" #1093

Merged

5 tasks

jcstein added the P0 label

This was referenced Oct 18, 2023

make a guide for docs readme “how to update docs” #873

Closed

Tracking EPIC for documentation #1180

Closed

jcstein added the documentation label

jcstein pinned this issue

Bidon15 added good first issue help wanted and removed P0 labels

Member

Bidon15 commented Mar 11, 2024

This is literally a chatGPT run of the entire doc section

Member Author

jcstein commented Mar 11, 2024

Can be added to readme

Bidon15 unpinned this issue

jcstein pinned this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment