Skip to content

docs: Add Documentation and Code Exploration Badges to README #167#169

Merged
LuchoBazz merged 1 commit intomainfrom
docs/add-readme-wiki-badges
Jan 10, 2026
Merged

docs: Add Documentation and Code Exploration Badges to README #167#169
LuchoBazz merged 1 commit intomainfrom
docs/add-readme-wiki-badges

Conversation

@LuchoBazz
Copy link
Copy Markdown
Owner

Pull Request Description

This Pull Request enhances the project’s README by adding two new informational badges that improve discoverability and accessibility of the project’s documentation and source code.

Specifically, it introduces:

  • An “Ask DeepWiki” badge that provides direct access to the project’s DeepWiki page, enabling users to explore structured documentation and ask contextual questions about the repository.
  • A “View Code Wiki” badge that links to Google’s Code Wiki interface, offering an alternative way to browse and understand the codebase.

Additional Details

  • These changes are documentation-only and do not affect the project’s functionality, API, or build process.
  • The badges are placed alongside existing badges to maintain visual consistency and improve visibility.
  • This update aims to improve the onboarding experience for new users and contributors by making learning resources more readily available.
  • No breaking changes are introduced, and no versioning or dependency updates are required.

@LuchoBazz LuchoBazz marked this pull request as ready for review January 10, 2026 16:52
@LuchoBazz LuchoBazz requested a review from Copilot January 10, 2026 16:52
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the README by adding two new documentation discovery badges that provide alternative ways to explore the project's codebase and documentation.

Changes:

  • Added "Ask DeepWiki" badge linking to DeepWiki interface for structured documentation exploration
  • Added "View Code Wiki" badge linking to Google's Code Wiki for alternative code browsing

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

@LuchoBazz LuchoBazz changed the title docs: Add Documentation and Code Exploration Badges to README docs: Add Documentation and Code Exploration Badges to README #167 Jan 10, 2026
@LuchoBazz LuchoBazz merged commit 64b3a38 into main Jan 10, 2026
3 checks passed
@LuchoBazz LuchoBazz deleted the docs/add-readme-wiki-badges branch January 10, 2026 17:02
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