Summary
The current CONTRIBUTING.md covers code contributions well but lacks guidance on how to contribute to the documentation, specifically how to build the docs locally and how to add new example notebooks
Proposed addition
Add a ### Documentation section to CONTRIBUTING.md covering how to build the docs locally with Sphinx, how to test notebooks with nbmake, how to run pre-commit checks on notebooks, guidelines for writing good example notebooks(real world datasets, meaningful research questions, toctree registration)
Motivation
This would lower the barrier for new contributors who want to add examples or improve documentation, and aligns with the existing code contribution workflow already described in the file
Summary
The current
CONTRIBUTING.mdcovers code contributions well but lacks guidance on how to contribute to the documentation, specifically how to build the docs locally and how to add new example notebooksProposed addition
Add a
### Documentationsection toCONTRIBUTING.mdcovering how to build the docs locally with Sphinx, how to test notebooks withnbmake, how to run pre-commit checks on notebooks, guidelines for writing good example notebooks(real world datasets, meaningful research questions,toctreeregistration)Motivation
This would lower the barrier for new contributors who want to add examples or improve documentation, and aligns with the existing code contribution workflow already described in the file