feat：add document

[xuanlid]

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

新增2.0新特性 1.路由 2.大纲树文档优化

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 new guides covering nested routing, route bar features, and RouterView subpage previews in the visual editor.
  • Expanded documentation for the outline tree, detailing drag-and-drop, multi-selection, keyboard shortcuts, and advanced interactions.
  • Included illustrative images, GIFs, and step-by-step instructions to enhance user understanding of new and existing features.

[coderabbitai[bot]]

Walkthrough

Several new and expanded documentation files were introduced, focusing on advanced features related to page routing, navigation, and outline tree interactions in a visual editor or page management system. The updates cover support for nested routing, enhancements to the route bar (including current page highlighting and preview path clearing), advanced RouterView preview capabilities, and a comprehensive revision of the outline tree documentation. These documents provide detailed usage instructions, UI behavior explanations, and illustrative examples to guide users through new and existing functionalities.

Changes

File(s)	Change Summary
docs/advanced-features/page-support-nested-route.md	Added documentation describing nested routing support, including page hierarchy, drag-and-drop nesting, navigation setup, RouterLink enhancements, multi-level rendering, and preview features.
docs/advanced-features/route-bar-clear-preview-page.md	Introduced documentation for a route bar feature that allows users to reset the preview page path to a placeholder with a single click, including a usage example and illustrative GIF.
docs/advanced-features/route-bar-current-page-highlight.md	Added documentation explaining how the route bar displays and highlights the current preview path and editing page, with an illustrative image.
docs/advanced-features/route-view-support-preview-subpage.md	New documentation detailing how RouterView supports subpage previewing in the editor, including UI interactions, nested previews, and visual cues for read-only mode, with step-by-step guides and images/GIFs.
docs/basic-features/outline-tree.md	Significantly expanded the outline tree documentation to cover UI presentation, drag-and-drop interactions, drag restrictions, horizontal scrolling, multi-selection, and keyboard shortcuts, with new sections and visuals.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EditorUI
    participant PageTree
    participant RouterView
    participant PreviewPane

    User->>EditorUI: Create or select root page
    User->>PageTree: Add child pages (nested)
    User->>EditorUI: Drag navigation bar and RouterView to root page
    User->>EditorUI: Interact with RouterLink (hover, right-click)
    EditorUI->>RouterView: Render parent and selected child page(s)
    User->>EditorUI: Toggle preview mode or reset route view
    EditorUI->>PreviewPane: Display nested or placeholder view as selected

Poem

🐇
In docs we hop, new routes appear,
Nested pages, structure clear.
Outline trees now branch and bend,
With shortcuts, drags, and friends to send.
Route bars highlight, previews reset—
A warren of features, our best yet!
🥕

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.