Skip to content

Conversation

@kagol
Copy link
Member

@kagol kagol commented Nov 13, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation
    • Added badge links for Ask DeepWiki resource in both English and Chinese README files to enhance resource discoverability.

@github-actions github-actions bot added the documentation 对文档的改进或补充 label Nov 13, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 13, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This PR adds badge links to DeepWiki in both English and Chinese README files. Both changes insert a new Markdown badge line following existing documentation sections, with no modifications to code logic, runtime behavior, or control flow.

Changes

Cohort / File(s) Change Summary
Documentation badge additions
README.md,
README.zh-CN.md
Added a new badge link line referencing Ask DeepWiki / DeepWiki after existing description paragraphs in both the English and Chinese README files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • These are purely cosmetic documentation updates with no logic or behavioral changes
  • Identical pattern applied consistently across two files
  • No dependencies, configurations, or code logic affected

Poem

🐰 A badge here, a link there,
DeepWiki shines with colorful flair!
The README gleams, oh what a sight,
Documentation now feels just right! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kagol/docs-update-README

📜 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 6349cdd and 0c2603f.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • README.zh-CN.md (1 hunks)

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.

@kagol kagol merged commit 76dbda7 into dev Nov 13, 2025
6 checks passed
@kagol kagol deleted the kagol/docs-update-README branch November 13, 2025 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 对文档的改进或补充

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants