Contribute Documentation¶

Thunder Engine documentation is an open project, and we welcome community contributions. This section contains guides on contributing to the documentation, style guidelines, and the review process.

Overview¶

Thunder Engine documentation is written in reStructuredText (RST) format and built using Sphinx. All documentation files are located in the thunder-engine/thunder-doc repository.

Ways to Contribute¶

You can contribute in several ways:

Fix typos and errors — the easiest way to help
Expand existing sections — add examples, clarify descriptions
Create new documentation — for missing features or components
Translations — help with translating to other languages
Reviews — review pull requests from other contributors

Getting Started¶

Clone the repository
Install build tools
Build the documentation locally

The build result will be in the _build/html/ folder. Open index.html in your browser to view it.
Create a branch for your changes
Make changes and submit a pull request

Documentation Structure¶

The documentation is organized in the following structure:

Files and Their Purpose¶

File	Purpose
`index.rst`	Section entry point, contains toctree and general description
`*.rst`	Documentation in reStructuredText format
`conf.py`	Sphinx settings (theme, extensions, paths)
`_static/`	Images, CSS, JavaScript files
`_build/`	Generated HTML documentation (in .gitignore)

The following pages contain detailed guides:

Documentation Writing Guide — how to write and format documentation
Documentation Style Guide — text and code style guidelines
Documentation Review Process — pull request review process