Skip to content

Conversation

@betterdancing
Copy link
Contributor

@betterdancing betterdancing commented Oct 29, 2025

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?

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

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Resource Management docs: add/edit/delete/copy resources, upload or add via URL, batch operations, category management, and using resources in components with examples and UI references.
    • Expanded Page/App/Block Preview docs: device-width switching, language (i18n) options, state reactivity, form validation, app preview with manual routing checks, new example images, and clearer walkthroughs.
    • Updated documentation catalog structure.

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 29, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 29, 2025

Walkthrough

Documentation expanded: the preview article was renamed and broadened to cover page, application, and block previews; a new Resource Management guide was added; and docs/catalog.json was updated to list the two new articles and adjust a few entries.

Changes

Cohort / File(s) Summary
Preview documentation
docs/basic-features/page-app-and-block-preview.md
Expanded and reorganized preview documentation to cover 页面预览、应用预览与区块预览: added 前言、入口说明、示例画布结构与预览页效果, device-width switching, i18n examples, state reactivity, form validation/submission, routing checks, and multiple illustrative images.
Resource management doc
docs/basic-features/resources-management.md
New guide for Resource Management: resource categories, add via URL/upload, edit/delete/copy, bulk operations, using resources in components (SourceSelectConfigurator), and bundle.json config examples; includes UI element references and images.
Documentation catalog
docs/catalog.json
Updated catalog to replace single preview entry with two entries (resources-management, page-app-and-block-preview) and converted several plain entries into object-form entries (e.g., utils, docker deploy); adjusted ordering to include new files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🐰
New pages bloom with images bright,
Resources sorted, previews light.
I nibble docs and tidy things,
A hop, a tweak — the garden sings. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly and directly summarizes the main changes: adding documentation for app-preview and resource-management features.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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.

@betterdancing betterdancing changed the title Feat/model app preview document Feat/document: Add documents of app-preview & resource-management Oct 29, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between c27e843 and 51a763f.

⛔ Files ignored due to path filters (11)
  • docs/basic-features/imgs/addResources.png is excluded by !**/*.png
  • docs/basic-features/imgs/addResourcesGroup.png is excluded by !**/*.png
  • docs/basic-features/imgs/batchResourceAction.png is excluded by !**/*.png
  • docs/basic-features/imgs/modifyBundleForResourceBind.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-app-pre.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-app.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-popover-app.png is excluded by !**/*.png
  • docs/basic-features/imgs/preview-popover-page.png is excluded by !**/*.png
  • docs/basic-features/imgs/resourceBind.png is excluded by !**/*.png
  • docs/basic-features/imgs/resourcedelOrCopy.png is excluded by !**/*.png
  • docs/basic-features/imgs/resourcegroupUpdate.png is 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.

@hexqi hexqi added this to the v2.10.0 milestone Dec 30, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

@hexqi hexqi changed the title Feat/document: Add documents of app-preview & resource-management docs: Add documents of app-preview & resource-management Feb 3, 2026
@github-actions github-actions bot removed the enhancement New feature or request label Feb 3, 2026
@hexqi hexqi merged commit e731e10 into opentiny:develop Feb 3, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants