Skip to content

docs(site): add missing sider in tutorials for en and zh#5940

Open
WuMingDao wants to merge 3 commits into
eggjs:nextfrom
WuMingDao:add-missing-sider-in-tutorials
Open

docs(site): add missing sider in tutorials for en and zh#5940
WuMingDao wants to merge 3 commits into
eggjs:nextfrom
WuMingDao:add-missing-sider-in-tutorials

Conversation

@WuMingDao
Copy link
Copy Markdown

@WuMingDao WuMingDao commented May 9, 2026

image

I found this missing, and it is in the en docs too

I checked #5610 , but this does not say this change?

Finally, I found MongoDB in docs not exist, everything zh docs or en docs

Summary by CodeRabbit

  • Documentation
    • Updated tutorial navigation in English and Chinese documentation.
    • MongoDB tutorial moved out of featured items in English.
    • Redis tutorial added to Chinese documentation.
    • Sequelize tutorial re-enabled in Chinese documentation.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 46e93abf-68e0-433d-aeae-77dadf3e0158

📥 Commits

Reviewing files that changed from the base of the PR and between 258a5ef and 8a862dd.

📒 Files selected for processing (1)
  • site/.vitepress/config.mts
🚧 Files skipped from review as they are similar to previous changes (1)
  • site/.vitepress/config.mts

📝 Walkthrough

Walkthrough

The PR updates VitePress sidebar tutorial lists: in English the MongoDB entry is disabled (commented out); in Chinese Redis is enabled, MongoDB is disabled (commented), and Sequelize is re-enabled.

Changes

VitePress Tutorial Navigation

Layer / File(s) Summary
Tutorial Sidebar Navigation
site/.vitepress/config.mts
English sidebar removes MongoDB from active items (commented out). Chinese sidebar enables Redis, comments out MongoDB, and re-enables Sequelize.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through menus bright,
Toggling links by lantern light.
Mongo sleeps, Redis leaps awake,
Sequelize joins the tutorial stake.
Hooray — a tidy docs remake!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions 'add missing sider' but the actual changes involve toggling existing tutorial links (commenting/uncommenting MongoDB, Redis, Sequelize) and updating sidebar configuration, not adding missing entries. Update the title to accurately reflect the changes, such as 'docs(site): toggle database tutorials in sidebar for en and zh' or 'docs(site): update tutorial sidebar visibility for MongoDB, Redis, and Sequelize'.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the tutorial sidebar configuration in VitePress, adding new entries for static assets, proxy patterns, Sequelize, and TypeScript, while enabling Redis and Sequelize in the Chinese documentation. Feedback suggests removing the commented-out MongoDB entry to maintain a cleaner configuration and renaming 'Assets Static Resource' and 'Proxy Agent Model' to 'Static Assets' and 'Proxy Pattern' for better idiomatic English.

{ text: 'MySQL', link: 'mysql' },
{ text: 'Redis', link: 'redis' },
{ text: 'MongoDB', link: 'mongodb' },
// { text: 'MongoDB', link: 'mongodb' },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Since the MongoDB tutorial does not exist (as noted in the PR description), it is better to remove this entry entirely rather than leaving it as commented-out code. This keeps the configuration file clean and avoids potential confusion for users and future maintainers.

Comment thread site/.vitepress/config.mts Outdated
Comment on lines +332 to +333
{ text: 'Assets Static Resource', link: 'assets' },
{ text: 'Proxy Agent Model', link: 'proxy' },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The labels 'Assets Static Resource' and 'Proxy Agent Model' are slightly redundant and not standard English terminology. Using 'Static Assets' and 'Proxy Pattern' would be more idiomatic and consistent with the Chinese counterparts ('静态资源' and '代理模式').

        { text: 'Static Assets', link: 'assets' },
        { text: 'Proxy Pattern', link: 'proxy' },

WuMingDao added 2 commits May 9, 2026 22:07
Signed-off-by: WuMingDao <146366930+WuMingDao@users.noreply.github.com>
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