Mukan Erkin Törük
20afb5db80
Some checks failed
Build SimApp / build (amd64) (push) Waiting to run
Build SimApp / build (arm64) (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
Build & Push / build (push) Waiting to run
Run Gosec / Gosec (push) Waiting to run
Lint / golangci-lint (push) Waiting to run
Checks dependencies and mocks generation / Check go mod tidy (push) Waiting to run
Checks dependencies and mocks generation / Check up to date mocks (push) Waiting to run
System Tests / setup (push) Waiting to run
System Tests / test-system (push) Blocked by required conditions
System Tests / test-system-legacy (push) Blocked by required conditions
Tests / Code Coverage / split-test-files (push) Waiting to run
Tests / Code Coverage / tests (00) (push) Blocked by required conditions
Tests / Code Coverage / tests (01) (push) Blocked by required conditions
Tests / Code Coverage / tests (02) (push) Blocked by required conditions
Tests / Code Coverage / tests (03) (push) Blocked by required conditions
Tests / Code Coverage / test-integration (push) Waiting to run
Tests / Code Coverage / test-e2e (push) Waiting to run
Tests / Code Coverage / repo-analysis (push) Blocked by required conditions
Tests / Code Coverage / test-sim-nondeterminism (push) Waiting to run
Tests / Code Coverage / test-clientv2 (push) Waiting to run
Tests / Code Coverage / test-core (push) Waiting to run
Tests / Code Coverage / test-depinject (push) Waiting to run
Tests / Code Coverage / test-errors (push) Waiting to run
Tests / Code Coverage / test-math (push) Waiting to run
Tests / Code Coverage / test-schema (push) Waiting to run
Tests / Code Coverage / test-collections (push) Waiting to run
Tests / Code Coverage / test-cosmovisor (push) Waiting to run
Tests / Code Coverage / test-confix (push) Waiting to run
Tests / Code Coverage / test-store (push) Waiting to run
Tests / Code Coverage / test-log (push) Waiting to run
Tests / Code Coverage / test-x-tx (push) Waiting to run
Tests / Code Coverage / test-x-nft (push) Waiting to run
Tests / Code Coverage / test-x-circuit (push) Waiting to run
Tests / Code Coverage / test-x-feegrant (push) Waiting to run
Tests / Code Coverage / test-x-evidence (push) Waiting to run
Tests / Code Coverage / test-x-upgrade (push) Waiting to run
Tests / Code Coverage / test-tools-benchmark (push) Waiting to run
Build & Push SDK Proto Builder / build (push) Has been cancelled
40 lines
2 KiB
Markdown
40 lines
2 KiB
Markdown
# Documentation Writing Guidelines
|
|
|
|
## Best Practices
|
|
|
|
* Check the spelling and grammar, even if you have to copy and paste from an external source.
|
|
* Use simple sentences. Easy-to-read sentences mean the reader can quickly use the guidance you share.
|
|
* Try to express your thoughts in a concise and clean way.
|
|
* Don't abuse `code` format when writing in plain English.
|
|
* Follow Google developer documentation [style guide](https://developers.google.com/style).
|
|
* Check the meaning of words in Microsoft's [A-Z word list and term collections](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms) (use the search input!).
|
|
* RFC keywords should be used in technical documents (uppercase) and we recommend to use them in user documentation (lowercase). The RFC keywords are: "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL. They are to be interpreted as described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119).
|
|
|
|
### Links
|
|
|
|
**NOTE:** Strongly consider the existing links - both within this directory and to the website docs - when moving or deleting files.
|
|
|
|
Relative links should be used nearly everywhere, due to versioning. Note that in case of page reshuffling, you must update all links references.
|
|
When deleting a link, redirects must be created in `docusaurus.config.js` to preserve the user flow.
|
|
|
|
### Code Snippets
|
|
|
|
Code snippets can be included in the documentation using normal Markdown code blocks. For example:
|
|
|
|
```md
|
|
```go
|
|
func() {}
|
|
```
|
|
```
|
|
|
|
It is also possible to include code snippets from GitHub files by referencing the files directly (and the line numbers if needed). For example:
|
|
|
|
```md
|
|
```go reference
|
|
https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/server/types/app.go#L57-L59
|
|
```
|
|
```
|
|
|
|
## Technical Writing Course
|
|
|
|
Google provides a free [course](https://developers.google.com/tech-writing/overview) for technical writing.
|