CONTRIBUTING.md

Change the documentation

The public nerudo/docs repository is the source for Nerudo documentation. The site reads the Markdown and navigation.json from the repository. A merged documentation change does not require an app deployment.

Write a guide

1. Add or change a Markdown file.
2. Use a short description of the purpose before the procedure.
3. Define technical terms before their first use.
4. Use numbered steps with one action per sentence.
5. Include the expected result and the access limits.
6. Update navigation.json if you add a guide.
7. Examine the links and command examples.
8. Enter python3 scripts/check-links.py to check local links.
9. Submit the change for repository review.

Use ASD-STE100 Issue 9 as the writing reference. Use the project technical terms consistently. Keep each instruction sentence within 20 words and each description sentence within 25 words. Do not change the spelling of commands, field names, or product names.

Add links

Use relative Markdown links between guides. For example:

[Signing keys](account/signing-keys.md)[Make a credential](account/developer-access.md#make-a-developer-credential)

The site changes these links to documentation page links. Heading links work on the documentation site and in the repository preview. Use full https://nerudo.dev/settings/... URLs for links to account controls. Other repository files open in the repository browser.

Keep settings brief

Settings pages contain account state, short explanations, and controls. Put detailed setup steps, examples, and troubleshooting in this repository. Link each settings section to the applicable guide or heading.

Protect private information

Use placeholders in examples. Never add private keys, credential values, account exports, or sign-in links. A maintainer must approve changes under this repository's nerudo.toml policy.