Skip to content

docs: update readme with new documentation links#11

Merged
416rehman merged 1 commit into
mainfrom
feature/docs-readme
Apr 28, 2026
Merged

docs: update readme with new documentation links#11
416rehman merged 1 commit into
mainfrom
feature/docs-readme

Conversation

@416rehman

Copy link
Copy Markdown
Owner

What does this PR do?

Related issues

How to test

Checklist

  • ruff check . and ruff format --check . pass
  • bandit -ll -ii -c pyproject.toml -r . passes
  • pytest passes
  • Tests added/updated if needed

Copilot AI review requested due to automatic review settings April 28, 2026 04:54
@416rehman 416rehman merged commit c6ef8a9 into main Apr 28, 2026
3 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project README to point users to the new hosted documentation site.

Changes:

  • Add a “Docs” badge linking to the new documentation domain.
  • Update the “Official Documentation” link to the new domain.
  • Update the Quickstart documentation link to the new domain (including the /en/ path).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants