Skip to content

Add DeepWiki badge for Nuxt to README #33508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add DeepWiki badge for Nuxt to README #33508

wants to merge 2 commits into from
+1 −0

Conversation

@franklin-tina
Copy link
Contributor

@franklin-tina franklin-tina commented Oct 17, 2025

DeepWiki provides in-depth documentation for public (and, in some cases, private) repositories. Adding this badge ensures that the content is automatically refreshed and always stays up to date.
See Nuxt docs in DeepWiki

P.S. Rolldown and Hono are among the popular repositories adopting this as well.

🔗 Linked issue

📚 Description

@franklin-tina
Add DeepWiki badge for NitroJS to README
79a0826 
[DeepWiki](https://deepwiki.com) provides in-depth documentation for public (and, in some cases, private) repositories. Adding this badge ensures that the content is automatically refreshed and always stays up to date.
See [Nuxt docs in DeepWiki](https://deepwiki.com/nuxt/nuxt)

P.S. [Rolldown](https://github.com/rolldown/rolldown/blob/main/README.md) and [Hono](https://github.com/honojs/hono/blob/main/README.md) are among the popular repositories adopting this as well.
@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Oct 17, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot added the 4.x label Oct 17, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 17, 2025 •
edited
Loading

Walkthrough

Adds a DeepWiki badge and link to the README badges section. The badge is inserted after the Nuxt OpenSSF scorecard badge in the header area. No changes to application logic, data flow, error handling, exported/public declarations, or other files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Add DeepWiki badge for Nuxt to README" directly and accurately describes the main change in the changeset. The title is concise, specific, and clearly indicates what is being added and where, without vague terminology or noise. It aligns perfectly with the raw summary, which documents the addition of a new DeepWiki badge to the README badge sections.
Description Check ✅ Passed The pull request description is clearly related to the changeset and provides relevant context. It explains what DeepWiki is, why the badge is being added (to keep documentation automatically refreshed and up to date), and provides supporting evidence by referencing other repositories that have adopted this badge. The description is on-topic and conveys meaningful information about the change, meeting the lenient criteria for this check.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79a0826 and fab264e.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: code

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

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

coderabbitai[bot]
coderabbitai bot reviewed Oct 17, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39dd9b6 and 79a0826.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: code

danielroe
danielroe reviewed Oct 17, 2025
View reviewed changes
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

it might be worth linking elsewhere rather than in the readme?

I'm not sure how frequently someone looking for help starts at the readme badges...

@franklin-tina @danielroe
Update README.md
fab264e 
Co-authored-by: Daniel Roe <daniel@roe.dev>
@franklin-tina
Copy link
Contributor Author

franklin-tina commented Oct 17, 2025 •
edited
Loading

it might be worth linking elsewhere rather than in the readme?

I'm not sure how frequently someone looking for help starts at the readme badges...

I think this is mainly for DeepWiki to auto refresh the content in its memory.
Also, I added it to Readme based on recommendation from DeepWiki and what other repos are doing (See references to Rolldown and Hono I linked in the PR description)

(I personally use DeepWiki for deep dives, but I'm opened to suggestions)

Edit:
I think most repos are adding this to the README.
See this in Grep

@danielroe
Copy link
Member

danielroe commented Oct 17, 2025

do you have any info on how adding the badge helps with auto refreshing the content in its memory?

@franklin-tina
Copy link
Contributor Author

franklin-tina commented Oct 17, 2025 •
edited
Loading

do you have any info on how adding the badge helps with auto refreshing the content in its memory?

TLDR;
The docs in DeepWiki show you when it was last indexed.
Screenshot 2025-10-17 at 12 00 00

There's an option to "refresh" the docs, which requires your email (they'll send an email when re-indexing is complete. I've added a couple of unjs repos to DeepWiki and re-indexed a couple)
Screenshot 2025-10-17 at 12 00 56

When you enter your email and refresh, they give you this option to add the badge
Screenshot 2025-10-17 at 12 02 46

Screenshot 2025-10-17 at 12 03 30

Clicking the "Create badge" takes you to the badge maker page:
Screenshot 2025-10-17 at 12 04 23

Screenshot 2025-10-17 at 12 15 09

As for the internals on how they do it, I don't know... but I know and have seen it work.
If this is not necessary, I'll go back to manually re-indexing them periodically (hopefully others in the community help too 😅)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@danielroe danielroe Awaiting requested review from danielroe danielroe is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

4.x

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@franklin-tina @danielroe