Skip to content

docs: Add context7 & codewiki badges - #8

Open
stefashkaa wants to merge 1 commit into
mainfrom
docs/add-context7-and-codewiki-badges
Open

docs: Add context7 & codewiki badges#8
stefashkaa wants to merge 1 commit into
mainfrom
docs/add-context7-and-codewiki-badges

Conversation

@stefashkaa

@stefashkaa stefashkaa commented Sep 10, 2026

Copy link
Copy Markdown
Member

Description

  • What does this PR do?

    • Adds context7 badge for each README.md file
    • Adds code wiki badge for each README.md file
  • Why is this change needed?

    • Highlights library listings with AI generated documentation and other helpers support

Type of Change

  • Bug fix (non-breaking)
  • New feature (non-breaking)
  • Breaking change
  • Documentation update
  • Tests
  • Maintenance

Testing

  • Checked badges visually

Screenshots (if applicable)

  • N/A

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Comments added for complex code
  • Documentation updated
  • No new warnings generated
  • Tests added/updated
  • All tests passing

Run Coverage Workflow

Maintainers only (write/maintain/admin access): open the workflow, click Run workflow, and set pr_number to this PR number to post/update a coverage comment on this PR

Summary by CodeRabbit

  • Documentation
    • Added Context7 documentation and Google Code Wiki badges to the main project README.
    • Added the same documentation badges to the Angular, Core, Nuxt, React, Svelte, and Vue package READMEs.
    • Badges provide direct links to relevant documentation and code references.

Copilot AI lite review requested due to automatic review settings September 10, 2026 12:39
@vercel

vercel Bot commented Sep 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
context7-widget Ready Ready Preview Sep 10, 2026 12:40pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-10T12:43:24.392109Z 923e6e3 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 26c89fba-bf9d-41a6-b650-51798ec73b3e

📥 Commits

Reviewing files that changed from the base of the PR and between 80494a9 and 923e6e3.

📒 Files selected for processing (7)
  • README.md
  • packages/angular/README.md
  • packages/core/README.md
  • packages/nuxt/README.md
  • packages/react/README.md
  • packages/svelte/README.md
  • packages/vue/README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Added Context7 Docs and Code Wiki badges to the main README and Angular, core, Nuxt, React, Svelte, and Vue package READMEs.

Changes

Documentation badge updates

Layer / File(s) Summary
Add documentation badges
README.md, packages/*/README.md
Added Context7 Docs and Code Wiki badges to the README headers. The badges link to the project documentation and Code Wiki pages.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 923e6

This change only adds documentation badges and does not affect package behavior or production availability. It is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding Context7 and CodeWiki badges to the project README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-context7-and-codewiki-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit hops through README bright
Two badges gleam with links of light
Context7 guides the way
Code Wiki joins the display
Documentation blooms today

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

Copy link
Copy Markdown

@gitar-bot

gitar-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Adds context7 and codewiki badges to README.md files to highlight AI-generated documentation and helper support. No issues found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Counting what did not apply, without listing it.

Comment with these commands to change the behavior for this request:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 923e6e384b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
<br />
[![Coverage](https://codecov.io/gh/DeSource-Labs/context7-widget/branch/main/graph/badge.svg)](https://codecov.io/gh/DeSource-Labs/context7-widget)
[![SonarCloud](https://sonarcloud.io/api/project_badges/measure?project=DeSource-Labs_context7-widget&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DeSource-Labs_context7-widget)
[![Context7 Docs](https://img.shields.io/badge/context7-DOCS-blue.svg?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMjgiIGhlaWdodD0iMjgiIHZpZXdCb3g9IjAgMCAyOCAyOCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTI0IDBINEMxLjc5MDg2IDAgMCAxLjc5MDg2IDAgNFYyNEMwIDI2LjIwOTEgMS43OTA4NiAyOCA0IDI4SDI0QzI2LjIwOTEgMjggMjggMjYuMjA5MSAyOCAyNFY0QzI4IDEuNzkwODYgMjYuMjA5MSAwIDI0IDBaIiBmaWxsPSIjRjdGMkU4IiBmaWxsLW9wYWNpdHk9IjAuNjUiLz4KPHBhdGggZD0iTTEwLjYgMTUuMjk5MkMxMC42IDE3LjQ5OTIgOS43MDAwNSAxOS4zOTkyIDguMjAwMDUgMjEuMDk5MkgxMS42VjIyLjc5OTJINi4zMDAwNVYyMS4xOTkyQzguMDAwMDUgMTkuMzk5MiA4LjYwMDA1IDE3Ljg5OTIgOC42MDAwNSAxNS4yOTkySDEwLjZaTTE3LjQgMTUuMjk5MkMxNy40IDE3LjQ5OTIgMTguMyAxOS4zOTkyIDE5LjggMjEuMDk5MkgxNi40VjIyLjc5OTJIMjEuN1YyMS4xOTkyQzIwIDE5LjM5OTIgMTkuNCAxNy44OTkyIDE5LjQgMTUuMjk5MkgxNy40Wk0xMC42IDEyLjY5OTJDMTAuNiAxMC40OTkyIDkuNzAwMDUgOC41OTkyMiA4LjIwMDA1IDYuODk5MjJIMTEuNlY1LjE5OTIySDYuMzAwMDVWNi43OTkyMkM4LjAwMDA1IDguNTk5MjIgOC42MDAwNSAxMC4wOTkyIDguNjAwMDUgMTIuNjk5MkgxMC42Wk0xNy40IDEyLjY5OTJDMTcuNCAxMC40OTkyIDE4LjMgOC41OTkyMiAxOS44IDYuODk5MjJIMTYuNFY1LjE5OTIySDIxLjdWNi43OTkyMkMyMCA4LjU5OTIyIDE5LjQgMTAuMDk5MiAxOS40IDEyLjY5OTJIMTcuNFoiIGZpbGw9ImJsYWNrIi8+Cjwvc3ZnPgo=)](https://context7.com/desource-labs/context7-widget)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Percent-encode the custom logo's base64 plus sign

When Shields parses this URL's query parameters, the literal + near the end of the base64 payload is decoded as a space, removing a base64 character and corrupting the SVG's closing markup. As a result, the newly added Context7 badge cannot reliably render its intended logo; the same malformed URL is duplicated across all package READMEs. Encode the + as %2B, or URL-encode the complete data URI.

Useful? React with 👍 / 👎.

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.

🟡 Changes recommended

The newly added badge links use inconsistent repo/owner casing compared to existing README links, which could break on case-sensitive services and should be normalized before merge.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR updates repository documentation by adding new badges (Context7 docs and Code Wiki) to the root README and each package README, so readers can quickly discover the hosted docs/chat and wiki resources from any entry point.

Changes:

  • Add a “Context7 Docs” badge to each README.md.
  • Add a “Code Wiki” badge to each README.md.
File summaries
File Description
README.md Adds Context7 Docs + Code Wiki badges to the main project README.
packages/vue/README.md Adds Context7 Docs + Code Wiki badges to the Vue package README.
packages/svelte/README.md Adds Context7 Docs + Code Wiki badges to the Svelte package README.
packages/react/README.md Adds Context7 Docs + Code Wiki badges to the React package README.
packages/nuxt/README.md Adds Context7 Docs + Code Wiki badges to the Nuxt package README.
packages/core/README.md Adds Context7 Docs + Code Wiki badges to the Core package README.
packages/angular/README.md Adds Context7 Docs + Code Wiki badges to the Angular package README.
Review details
  • Files reviewed: 7/7 changed files
  • Comments generated: 7
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
Comment thread packages/angular/README.md
Comment thread packages/core/README.md
Comment thread packages/nuxt/README.md
Comment thread packages/react/README.md
Comment thread packages/svelte/README.md
Comment thread packages/vue/README.md
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