Document guidelines

This page defines writing and style rules for documentation under docs/.

Heading style

• Use Sentence case for all headings.
• Capitalize only the first word and proper nouns/acronyms.
• Keep existing official names as-is (for example, GitHub, API, NumPy, Qubex).

Examples:

• ## Documentation updates
• ## Pull request guidelines
• ## API compatibility

Writing principles

• Keep wording concise and concrete.
• Prefer imperative instructions for procedures.
• State assumptions and prerequisites explicitly.
• Avoid ambiguous terms such as "usually" or "might" without context.

Link and path style

• Use relative links for files in the same docs tree.
• Use inline code for paths and commands.
• Ensure links are valid after file moves/renames.

Maintenance

• Update related docs in the same pull request when behavior or APIs change.
• Keep examples minimal and consistent with current code.