Contributing¶
Contributions and issues are most welcome! All issues and pull requests are handled through GitHub. Please check for any existing issues before filing a new one.
Issue or Pull Request?¶
Raise an issue if you want to report a bug or request a feature. Open a pull request if you already have a change ready to propose. If you are unsure, raise an issue first to discuss the change.
Documentation¶
Documentation is built with MyST and published to GitHub Pages.
The docs follow the Diátaxis framework — tutorials, how-to
guides, reference and explanations. See how-to/contribute for the documentation
authoring conventions and the cross-repository link setup.
Cross-repository references¶
PandABlocks docs cross-link to the other repos with MyST xref: links,
configured in docs/myst.yml under project.references. For the link syntax,
when to use each target type, and the list of available reference targets, see
the documentation standards reference.
Upstreaming to the copier template¶
The project.references block in docs/myst.yml is a prototype intended for
upstreaming into the
python