Skip to content

docs: add GitHub and DeepWiki links - #34

Merged
daguanren21 merged 2 commits into
mainfrom
feat/registry-component-upgrades
Oct 23, 2026
Merged

daguanren21 merged 2 commits into
mainfrom
feat/registry-component-upgrades

Conversation

@daguanren21

@daguanren21 daguanren21 commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Add a GitHub icon to the shared documentation navigation and DeepWiki links to both language resource menus and READMEs, so readers can reach the repository and code documentation directly.

DeepWiki has accepted the repository's initial indexing request.

Validation:

  • Pre-commit ESLint, staged type checking, and commit-message checks passed.
  • pnpm typecheck passed through the pre-push hook (22 tasks; 21 cached).
  • Browser verification covered desktop (1440px) and mobile (390px) navigation, keyboard activation of the GitHub link, and Escape closing the mobile menu.

Summary by CodeRabbit

  • Documentation
    • Added a DeepWiki link to the English and Chinese README navigation and documentation menus, making the project’s DeepWiki resources accessible from both languages.
    • Added a GitHub link to the documentation theme’s social links for easier access to the project repository.

@changeset-bot

changeset-bot Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a43cfef

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: faab2db6-2e3b-439e-b8dd-2b844ac40332
📥 Commits

Reviewing files that changed from the base of the PR and between cd4f70b and a43cfef.

⛔ Files ignored due to path filters: 1
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing: 3
  • RELEASING.md
  • package.json
  • repoctl.config.ts

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

📝 Walkthrough

The README and documentation menus add DeepWiki links, and the shared theme adds a GitHub social link. Release guidance, development dependency versions, and the lint-staged command configuration are also updated.

Changes: Documentation navigation

Layer / File(s) Summary
README and documentation navigation links
README.md, README.zh-CN.md, apps/docs/.vitepress/config.ts
The README files and Chinese and English navigation menus add DeepWiki links. The shared theme configuration adds a GitHub social link.

Release guidance and repository tooling

Layer / File(s) Summary
Release requirements and command guidance
RELEASING.md
Release instructions add the explicit @pnpm/logger development peer requirement, describe a JSON release-plan preview, and clarify which scripts repo check --full selects.
Development dependencies and lint-staged command
package.json, repoctl.config.ts
Development dependencies add @pnpm/logger and update version ranges for @vitest/coverage-v8, repoctl, stylelint, and vitest. The lint-staged configuration replaces monorepoCommand with repoCommand and retains the command value.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to a43cf

The release guidance and staged-check configuration match the upgraded tooling. No actionable merge-blocking issue remains after normal checks.

Pre-merge checks: Passed 5
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 primary changes: adding GitHub and DeepWiki links to the documentation navigation and READMEs.
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 2…
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.
Full details: Docstring Coverage

Explanation

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 2 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.

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.

@daguanren21
daguanren21 merged commit 47cbd70 into main Oct 23, 2026
2 checks passed
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.

1 participant