refactor(docs): shorten Core-flow filename, add mermaid support, translate english version#133
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Refactors the “Core execution flow” documentation by renaming it to a shorter filename, enabling Mermaid rendering in the Docusaurus site, and providing a fully translated English i18n version of the page.
Changes:
- Added Mermaid support to the Docusaurus configuration and dependencies.
- Updated the docs sidebar to include the renamed Core flow document.
- Added the new Core-flow documentation in both zh-Hans and en locales (English translated).
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/sidebars.js | Adds the new doc/Core-flow entry to the Components sidebar. |
| website/package.json | Adds @docusaurus/theme-mermaid dependency for Mermaid rendering. |
| website/docusaurus.config.js | Enables Mermaid in markdown and registers the Mermaid theme. |
| website/docs/doc/Core-flow.md | Adds/renames the Core flow documentation (zh-Hans) with Mermaid diagrams. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/Core-flow.md | Adds/renames the English i18n version and translates the full document content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
17
to
20
| "@docusaurus/core": "3.1.1", | ||
| "@docusaurus/preset-classic": "3.1.1", | ||
| "@docusaurus/theme-mermaid": "^3.1.1", | ||
| "@mdx-js/react": "^3.0.0", |
| | 步骤 | 文件 | 关键行 | | ||
| |------|------|--------| | ||
| | 入口分发 | `Bootstrap/GeneralUpdateBootstrap.cs` | `LaunchAsync()` @L125 | | ||
| | Upgade 路径 IPC 读取 | `Bootstrap/GeneralUpdateBootstrap.cs` | `InitializeFromEnvironment()` @L357 | |
…slate english version - Rename Core-execution-flow.md to Core-flow.md (short filename) - Install @docusaurus/theme-mermaid and enable mermaid in config - Translate english Core-flow.md from Chinese to English - Fix TOC anchor IDs for English version Co-Authored-By: Claude <noreply@anthropic.com>
JusterZhu
force-pushed
the
docs/core-execution-flow
branch
from
e2e412a to
2cda306
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three fixes for the Core-execution-flow documentation page:
1. Shorten filename
Core-execution-flow.md→Core-flow.md— too long, now concise.2. Add Mermaid flowchart support
The page contains 11 mermaid/flowchart diagrams but they rendered as plain text because Docusaurus was not configured for mermaid.
@docusaurus/theme-mermaidmarkdown: { mermaid: true }andthemes: ['@docusaurus/theme-mermaid']todocusaurus.config.js3. Translate English version
The English i18n file was identical to the Chinese original. Fully translated all sections, mermaid labels, code comments, tables, and TOC anchors.
Files changed
website/docs/doc/Core-flow.mdwebsite/i18n/en/.../Core-flow.mdwebsite/sidebars.jswebsite/docusaurus.config.jswebsite/package.json🤖 Generated with Claude Code