Adds a guide to contributing documents

[sinisaos]

Related to #459

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.04%. Comparing base (1157c12) to head (745f576).
⚠️ Report is 49 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #461      +/-   ##
==========================================
+ Coverage   93.42%   94.04%   +0.62%     
==========================================
  Files           5        5              
  Lines         365      403      +38     
==========================================
+ Hits          341      379      +38     
  Misses         24       24              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

This PR has been marked as stale because it has been open for 30 days with no activity. Are there any blockers, or should this be closed?

[dantownsend]

Could this just be requirements/doc-requirements.txt instead of requirements/readthedocs-requirements.txt?

[sinisaos]

No. If we run make html with previous pip install -r requirements/doc-requirements.txt, we will get ModuleNotFoundError

(doc_env) rkl@mint:~/dev/doc_env/piccolo_admin/docs$ make html
Running Sphinx v7.3.7

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/rkl/dev/doc_env/lib/python3.12/site-packages/sphinx/config.py", line 509, in eval_config_file
    exec(code, namespace)  # NoQA: S102
    ^^^^^^^^^^^^^^^^^^^^^
  File "/home/rkl/dev/doc_env/piccolo_admin/docs/source/conf.py", line 29, in <module>
    import piccolo_admin  # noqa
    ^^^^^^^^^^^^^^^^^^^^
  File "/home/rkl/dev/doc_env/piccolo_admin/piccolo_admin/__init__.py", line 1, in <module>
    from .endpoints import FormConfig, create_admin
  File "/home/rkl/dev/doc_env/piccolo_admin/piccolo_admin/endpoints.py", line 19, in <module>
    import typing_extensions
ModuleNotFoundError: No module named 'typing_extensions'

make: *** [Makefile:20: html] Error 2

With readthedocs-requirements.txt we don't have this problem because we use full requirements in that file

piccolo_admin/requirements/readthedocs-requirements.txt

Line 1 in 55c3ec7

-r requirements.txt

[dantownsend]

I see your point. Can we do this instead:

* Make sure the main requirements are installed: ``pip install -r requirements/requirements.txt``
* Install the documentation requirements: ``pip install -r requirements/requirements.txt``

I know it sounds weird, but I don't want to reference the readthedocs requirements, just because I want to keep that just for readthedocs, and we might move away from them in the future.

[sinisaos]

Done.

[dantownsend]

Looks great, thanks!