Chisel documentation

Documentation pages for Chisel.

Chisel repositories

• chisel - main repository of the project
• chisel-docs - documentation repository
• chisel-releases - collection of package slice definitions

Contribution guides

Prior to contributing, you must -

• read and get acquainted with the Ubuntu Code of Conduct and
• sign the Canonical contributor license agreement.

Style guides

The documentation follows the Diataxis principles.

The commits follow the Conventional Commits v1.0.0 guidelines.

Configure your environment

Chisel documentation is built on top of Sphinx starter pack and hosted on Read the Docs.

To work on the project, you will need to have Python, python3.12-venv, and make packages.

sudo apt install make python3 python3.12-venv

Build documentation locally

The Makefile in the docs/ directory contains many targets. To see all possible make commands, run make help.

To watch, build and serve the document, run make run. To learn more, check out the Sphinx starter pack website.

Submit a pull request

After submitting a pull request, a few Github workflows run automatically to test the changes. If one of those fails, click on the failing workflow to see the logs to troubleshoot.

Note: more tests will be added in the future.

After submitting a pull request, you changes will be reviewed by a project maintainer.

Get help

If you are a new contributor to documentation in general and would like some guidance, you can check out the Open Documentation Academy repository or ask a question on Open Documentation Academy discourse.

Report issues

To report issues or feature requests regarding the documentation, please fill out an issue in the chisel-docs repository.

For issues regarding Chisel itself, please report them in the chisel repository.

Contact

To contact the maintainers for any purposes, please use the Chisel room in Matrix.