tiny-engine icon indicating copy to clipboard operation
tiny-engine copied to clipboard

Feat/document: Add documents of app-preview & resource-management

Open betterdancing opened this issue 2 months ago • 1 comments

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] 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
  • [x] Documentation content changes
  • [ ] Other... Please describe:

Background and solution

上个版本新增了应用预览和资源管理,但是没有文档指导

What is the current behavior?

Issue Number: N/A

What is the new behavior?

新增了应用预览的文档和资源管理的使用文档

Does this PR introduce a breaking change?

  • [ ] Yes
  • [x] No

Other information

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Resource Management feature documentation.
    • Enhanced page, application, and block preview documentation with new visuals and detailed examples.
    • Updated documentation catalog structure.

betterdancing avatar Oct 29 '25 06:10 betterdancing

Walkthrough

Documentation 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

Cohort / File(s) Change Summary
Documentation updates
docs/basic-features/page-app-and-block-preview.md
Expanded existing content with new "Application Preview Entry" (应用预览入口) section; updated image references from preview-btn.png to preview-popover-page.png; added canvas page structure, preview visuals, and routing examples; removed prior form validation item.
New documentation
docs/basic-features/resources-management.md
Added comprehensive Resource Management feature guide covering: adding/editing resource categories, uploading or linking resources via URL, deletion and copying, batch operations, using resources in components via SourceSelectConfigurator, and bundle.json configuration.
Catalog structure
docs/catalog.json
Updated basic features to replace single "page-and-block-preview" entry with two entries: "resources-management" and "page-app-and-block-preview"; added new "model-driven" article to advanced features; reformatted docker deployment entry in solutions section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Catalog JSON changes are straightforward structural updates with clear mapping
  • Documentation content is new/updated text without logic dependencies
  • Minor attention needed to verify image file references in updated documentation match the stated changes

Poem

🐰✨ Docs bloom bright with features new,
Resources managed, previews true,
Applications dance in catalog's song,
A rabbit's guide to help along! 📚🎉

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 title "Feat/model app preview document" refers to a real aspect of the changeset—the addition of documentation for application preview. The PR objectives confirm that app preview documentation is one of the main additions in this pull request. However, the title is incomplete as it does not mention the resource management documentation, which is an equally significant addition being made in this PR. The changes include both a new resources-management.md file and an updated page-app-and-block-preview.md file, yet the title only alludes to the preview documentation aspect. While the instructions note that titles don't need to cover every detail, the omission of resource management represents a substantial portion of the changeset that goes unmentioned.
✨ Finishing touches
  • [ ] 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

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.

coderabbitai[bot] avatar Oct 29 '25 06:10 coderabbitai[bot]