docs: add runtime-rendering-solution.md

[littla2liyou]

English | 简体中文

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)
• Built its own designer, fully self-validated

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:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

添加并完善runtime-rendering相关文档

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• Documentation
  • Added a Chinese "Runtime Rendering Solution" guide in the Solutions section.
  • Covers quick start (env, dev server, launching runtime), navigation/routing rules, entry URLs and sample access examples.
  • Explains how materials and third‑party dependencies are handled at runtime and when manual CDN mapping is required.
  • Purely additive content; no changes to features, APIs, or configuration.

[coderabbitai]

Walkthrough

Added a new Chinese documentation file docs/solutions/runtime-rendering-solution.md describing the runtime renderer: quick start (env, dev server, launch), default navigation, URL/hash routing rules, dev/prod entry URLs with examples, and material/import-map handling (bundle.json and CDN mappings).

Changes

Cohort / File(s)

Summary

Docs docs/solutions/runtime-rendering-solution.md

New Chinese documentation covering runtime renderer usage: environment preparation and dev server start, launching renderer from designer, default navigation behavior, URL and hash-based routing rules (page segments, query params id/tenant/platform), dev (/runtime.html) and prod (/runtime) entry URLs with examples, material/package handling via bundle.json, and guidance for CDN subdependency mappings in packages/runtime-renderer/src/app-function/import-map.json (example: echarts → HUICharts).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Review focus: accuracy of routing rules and example URLs, correctness and clarity of import-map.json example and bundle.json guidance.

Poem

I hop on keys with whiskers bright,
I penned the runtime guide tonight.
Hash routes, bundles, CDN streams—so neat,
Devs can render pages quick as a beat.
Thump! A rabbit's clap for docs complete. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "docs: add runtime-rendering-solution.md" directly and accurately describes the primary change in the changeset, which is the addition of a new documentation file located at docs/solutions/runtime-rendering-solution.md. The title is concise, uses a clear "docs:" prefix convention, and is specific enough that a reviewer scanning the repository's git history would immediately understand that a new runtime rendering documentation file was added. The title avoids vague terms and unnecessary noise while conveying the exact nature of the change.

✨ 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 e438cc9 and f520c50.

📒 Files selected for processing (1)

• docs/solutions/runtime-rendering-solution.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/solutions/runtime-rendering-solution.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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 108919d and 7f152ae.

📒 Files selected for processing (1)

• docs/solutions/runtime-rendering-solution.md (1 hunks)

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/solutions/runtime-rendering-solution.md (1)

61-68: Clarify placeholder syntax in JSON example.

The import-map.json example uses placeholder variables like ${VITE_CDN_DOMAIN}, ${versionDelimiter}, and ${fileDelimiter}. A brief inline comment explaining these are environment-specific placeholders that get substituted at runtime would improve clarity for developers unfamiliar with the build setup.

Consider adding a clarifying comment:

  ```json
  // filepath: packages/runtime-renderer/src/app-function/import-map.json
+ // Note: ${VITE_CDN_DOMAIN}, ${versionDelimiter}, and ${fileDelimiter} are environment variables substituted at build time
  {
    "imports": {
      "echarts": "${VITE_CDN_DOMAIN}/echarts${versionDelimiter}5.4.1${fileDelimiter}/dist/echarts.esm.js"
    },
    "importStyles": {}
  }

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: CodeRabbit UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 7f152ae56d560a5765ed11faf45cf5c1bffd3b24 and e438cc97c526aef1d775a140765059e6e8a88151.

</details>

<details>
<summary>⛔ Files ignored due to path filters (5)</summary>

* `docs/solutions/imgs/runtime-designer-display.png` is excluded by `!**/*.png`
* `docs/solutions/imgs/runtime-entry.png` is excluded by `!**/*.png`
* `docs/solutions/imgs/runtime-import-map.png` is excluded by `!**/*.png`
* `docs/solutions/imgs/runtime-runtime-display.gif` is excluded by `!**/*.gif`
* `docs/solutions/imgs/runtime-runtime-display.png` is excluded by `!**/*.png`

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/solutions/runtime-rendering-solution.md` (1 hunks)

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>docs/solutions/runtime-rendering-solution.md (1)</summary><blockquote>

`1-68`: **Documentation is now substantive and complete.**

The previous review flagged this file as incomplete with only a heading. The current version provides comprehensive runtime-rendering documentation covering quick start, routing rules, entry URLs, and dependency management. The content addresses the PR objective of "adding and refining runtime-rendering related documentation."



Once the typo is corrected and image files are verified to exist, this documentation will be ready for merge.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[1degrees]

1、功能说明文档- 已完成
2、后期补下架构设计.md

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

1. Function description document - Completed
2. Add the architectural design later.md