Documentation & Localization guidelines
These guidelines aim to help the team and external contributors write, translate, publish, and collaborate on the Tarantool documentation.
The guidelines are a work in progress, and we welcome all contributions.
Contents:
- Language and style
- Localization
- Defining and using terms
- Markup reference
- Documenting the API
- Images
- Building Tarantool Docs
- Sphinx-build warnings reference
- Bullet list ends without a blank line; unexpected unindent
- Could not lex literal_block as “…”. Highlighting skipped
- Duplicate explicit target name: “…”
- Document isn’t included in any toctree
- Duplicate label “…”, other instance in “…/…/…”
- Malformed hyperlink target
- Anonymous hyperlink mismatch
- Toctree contains reference to nonexisting document ‘…’
- Undefined label: … (if the link has no caption the label must precede a section header)
- Unexpected indentation
- Unknown document
- Documentation infrastructure
- Git workflow