Skip to content

Docs/update contributing.md #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KaykCaputo merged 2 commits into from
Apr 4, 2026
Merged

Docs/update contributing.md #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
546d9f8
fix: gitignore generated docs path
waldo121 Apr 3, 2026
6bf42f1
docs: add required for docs dontribution
waldo121 Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ venv.bak/
.ropeproject

# mkdocs documentation
/site
docs/site

# mypy
.mypy_cache/
Expand Down
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ mkdocs build -f docs/mkdocs.yml

## Documentation Contributions

### Required

- [mkdocs](https://mkdocs.org)
- the packages listed in `mkdocs -f docs/mkdocs.yml get-deps` must be installed in your python environment

If your PR changes flags, behavior, output format, or workflows:

* Update the relevant page in [docs/docs](docs/docs)
Expand Down