-
Notifications
You must be signed in to change notification settings - Fork 458
docs: Add documents of app-preview & resource-management #1687
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add documents of app-preview & resource-management #1687
Conversation
…into feat/model-app-preview-document
…betterdancing/tiny-engine into feat/model-app-preview-document
WalkthroughDocumentation expanded: the preview article was renamed and broadened to cover page, application, and block previews; a new Resource Management guide was added; and Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/basic-features/page-app-and-block-preview.md (1)
1-1: Update file title to reflect expanded scope.The file title "## 页面/区块预览" does not match the catalog entry "页面、应用和区块预览" and does not reflect the new application preview section added in the file (lines 28–44). Update the title to include "应用" (application) for consistency.
-## 页面/区块预览 +## 页面、应用和区块预览
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (11)
docs/basic-features/imgs/addResources.pngis excluded by!**/*.pngdocs/basic-features/imgs/addResourcesGroup.pngis excluded by!**/*.pngdocs/basic-features/imgs/batchResourceAction.pngis excluded by!**/*.pngdocs/basic-features/imgs/modifyBundleForResourceBind.pngis excluded by!**/*.pngdocs/basic-features/imgs/preview-app-pre.pngis excluded by!**/*.pngdocs/basic-features/imgs/preview-app.pngis excluded by!**/*.pngdocs/basic-features/imgs/preview-popover-app.pngis excluded by!**/*.pngdocs/basic-features/imgs/preview-popover-page.pngis excluded by!**/*.pngdocs/basic-features/imgs/resourceBind.pngis excluded by!**/*.pngdocs/basic-features/imgs/resourcedelOrCopy.pngis excluded by!**/*.pngdocs/basic-features/imgs/resourcegroupUpdate.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/basic-features/page-app-and-block-preview.md(2 hunks)docs/basic-features/resources-management.md(1 hunks)docs/catalog.json(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: push-check
🔇 Additional comments (2)
docs/basic-features/resources-management.md (1)
1-44: Well-structured new documentation for Resource Management.The documentation is logically organized, progressing through typical user workflows from basic operations (creating categories, adding resources) to advanced scenarios (batch operations, integration with other components). Each section includes descriptive text, visual aids, and procedural guidance.
Verify that all image files referenced in this file exist in the docs/imgs directory.
docs/catalog.json (1)
109-112: Standardize entry format - good change.Converting the plain string entry to an object format with "title" and "name" properties ensures consistency across the catalog structure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/basic-features/page-app-and-block-preview.md`:
- Line 35: Replace the phrase "应用预览即是" with "应用预览既是" in the sentence (the
snippet that currently reads "应用预览即是解决这个问题...") so the wording reads naturally
in Chinese; update the Markdown content in page-app-and-block-preview.md
accordingly.
🧹 Nitpick comments (1)
docs/basic-features/page-app-and-block-preview.md (1)
3-3: Fix heading level jumps (H1 → H3).Use H2 for these section headings so the structure is consistent and markdownlint MD001 passes.
♻️ Proposed fix
-### 前言 +## 前言-### 前言 +## 前言Also applies to: 32-32
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/basic-features/page-app-and-block-preview.md`:
- Around line 3-4: The document uses H3 headings that skip H2 (e.g., "### 前言"
and other occurrences), so update each of those H3 headings to H2 to avoid
heading-level jumps: replace "###" with "##" for the "前言" heading and the other
H3 headings referenced (lines indicated in the review: 7-8, 13-14, 32-33, 37-38,
43-44, 49-50) so each H3 becomes H2 and the document hierarchy no longer skips
H2 under the H1 sections.
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Background and solution
上个版本新增了应用预览和资源管理,但是没有文档指导
What is the current behavior?
Issue Number: N/A
What is the new behavior?
新增了应用预览的文档和资源管理的使用文档
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit