Feat/document: Add documents of app-preview & resource-management #1687
Conversation
…into feat/model-app-preview-document
…betterdancing/tiny-engine into feat/model-app-preview-document
github-actions bot added documentation 
WalkthroughDocumentation was restructured and expanded: the page preview documentation was renamed and enhanced to cover application and block previews, a new resources management guide was added, and the catalog was updated to reflect these structural changes including a new model-driven article entry. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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 |
betterdancing changed the title ![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
| { | ||
| "title": "资源管理", | ||
| "name": "resources-management.md" | ||
| }, | ||
| { | ||
| "title": "页面、应用和区块预览", | ||
| "name": "page-app-and-block-preview.md" | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
Verify new documentation files exist.
The catalog now references three new or relocated documentation files. Ensure that all referenced files exist and are correctly placed:
docs/basic-features/resources-management.md(new)docs/basic-features/page-app-and-block-preview.md(updated)docs/advanced-features/model-driven.md(new in development section)
Also applies to: 46-49
🏁 Script executed:
#!/bin/bash # Description: Verify all markdown files referenced in catalog.json exist # Extract all .md references from catalog.json and verify files exist files=$(grep -o '"[^"]*\.md"' docs/catalog.json | tr -d '"' | sort -u) echo "=== Checking referenced files ===" missing=0 for file in $files; do full_path="docs/$file" if [ -f "$full_path" ]; then echo "✓ $full_path" else echo "✗ MISSING: $full_path" missing=$((missing + 1)) fi done echo "" if [ $missing -eq 0 ]; then echo "All referenced files exist." else echo "ERROR: $missing file(s) missing." exit 1 fiLength of output: 4248
🏁 Script executed:
#!/bin/bash # Check directory structure and find where markdown files actually are echo "=== Docs directory structure (top level) ===" ls -la docs/ 2>/dev/null | head -20 echo "" echo "=== Subdirectories in docs/ ===" find docs/ -maxdepth 1 -type d | sort echo "" echo "=== Sample markdown files in docs/ (up to 10) ===" find docs/ -name "*.md" -type f | head -10 echo "" echo "=== Total markdown files in docs/ ===" find docs/ -name "*.md" -type f | wc -lLength of output: 2261
🏁 Script executed:
#!/bin/bash # Check catalog.json format and verify new files exist echo "=== Catalog.json entries around lines 29-36 ===" sed -n '29,36p' docs/catalog.json echo "" echo "=== Catalog.json entries around lines 46-49 ===" sed -n '46,49p' docs/catalog.json echo "" echo "=== Checking if specific new files exist ===" echo "Checking: docs/basic-features/resources-management.md" [ -f "docs/basic-features/resources-management.md" ] && echo "✓ EXISTS" || echo "✗ MISSING" echo "Checking: docs/basic-features/page-app-and-block-preview.md" [ -f "docs/basic-features/page-app-and-block-preview.md" ] && echo "✓ EXISTS" || echo "✗ MISSING" echo "Checking: docs/advanced-features/model-driven.md" [ -f "docs/advanced-features/model-driven.md" ] && echo "✓ EXISTS" || echo "✗ MISSING" echo "" echo "=== All files in basic-features/ ===" ls -la docs/basic-features/ echo "" echo "=== All files in advanced-features/ ===" ls -la docs/advanced-features/Length of output: 3191
🏁 Script executed:
#!/bin/bash # Check full catalog structure to understand how flat names map to nested directories echo "=== Full catalog.json structure (first 80 lines to see pattern) ===" head -80 docs/catalog.json echo "" echo "=== Check content of model-driven.md ===" echo "File size:" wc -c docs/advanced-features/model-driven.md echo "" echo "Content (if any):" cat docs/advanced-features/model-driven.md echo "[END OF FILE]"Length of output: 3663
Add content to model-driven.md — currently empty.
All three referenced documentation files exist in their correct subdirectories and are properly registered in the catalog structure:
- ✓
docs/basic-features/resources-management.md - ✓
docs/basic-features/page-app-and-block-preview.md
However, docs/advanced-features/model-driven.md is an empty file (0 bytes). This file must have documentation content before merging.
🤖 Prompt for AI Agents
In docs/catalog.json around lines 29 to 36, the catalog references docs/advanced-features/model-driven.md but that file is empty; add meaningful documentation content to docs/advanced-features/model-driven.md (summary, purpose, usage, examples or links) so it is no longer a 0-byte file and accurately documents the model-driven feature before merging. 1 participant
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