Skip to content

docs(fix): fix documentation errors and mistakes - #21

Merged
paddy74 merged 7 commits into
mainfrom
docs/cleanup
Oct 9, 2025
Merged

docs(fix): fix documentation errors and mistakes#21
paddy74 merged 7 commits into
mainfrom
docs/cleanup

Conversation

@paddy74

@paddy74 paddy74 commented Oct 9, 2025

Copy link
Copy Markdown
Owner

This PR fixes various errors, mistakes, etc. in the documentation and ensures that it accurately reflects the existing state of the project.

  • Move documentation related packages to the docs group.
  • Reflect current project state in the README.md.
  • Add docs section to README.md.
  • Detail top-level module docstring.
  • Configure mkdocstrings to expect sphinx (reStructuredText) style docstrings.
  • Fix incorrect linking of objects in docstrings.
  • Add missing pages to the nav bar's About section.

@paddy74 paddy74 self-assigned this Oct 9, 2025
@paddy74 paddy74 added the bug Something isn't working label Oct 9, 2025
@codecov

codecov Bot commented Oct 9, 2025

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@paddy74
paddy74 merged commit f1629f0 into main Oct 9, 2025
8 checks passed
@paddy74
paddy74 deleted the docs/cleanup branch October 9, 2025 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant