Skip to content

Conversation

pavelacamposp
Copy link
Owner

This PR updates the README.md to include references to the project's documentation and bumps the version to 1.2.2.

This ensures the documentation is clearly referenced in the project's front page and is easily accessible from external sites like PyPI.

Key changes:

  • Added documentation references to README.md:
    • Added status badge linking to the docs.yml workflow.
    • Added a documentation link in the introduction section pointing to the project's GitHub Pages site.
  • Bumped project version to 1.2.2.

- Add status badge linking to the `docs.yml` workflow.
- Add a documentation link in the introduction section pointing to
  the project's GitHub Pages site.

This ensures the documentation is correctly referenced in the
`README.md` file and is easily accessible from external sites like
PyPI.
@pavelacamposp pavelacamposp self-assigned this Jul 16, 2025
@pavelacamposp
Copy link
Owner Author

All checks have passed, and the documentation is now clearly referenced in README.md. Merging now.

@pavelacamposp pavelacamposp merged commit dca810e into main Jul 16, 2025
5 checks passed
@pavelacamposp pavelacamposp deleted the chore/add-docs-to-readme branch July 16, 2025 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant