chore(@vben/docs): update docs [deploy]

[anncwb]

Description

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• Documentation
  • Added a new instruction to the setup documentation, specifying the need to run pnpm install for dependency installation.
  • Enhanced the documentation structure by integrating new links for quick-start guides, configuration, themes, localization, and access management, along with external links to official resources for better user navigation.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a836b62

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The recent changes to the documentation enhance the setup process and improve navigability. A new instruction for executing pnpm install has been added to ensure users properly install dependencies. Additionally, several links to quick-start guides, configuration, theme, localization, and access management have been integrated, enhancing user experience and making important resources more accessible.

Changes

Files	Change Summary
docs/src/guide/in-depth/ui-framework.md	Added instruction to execute pnpm install to clarify dependency installation for project setup.
docs/src/index.md	Integrated multiple links with corresponding texts for quick-start guides, configuration, themes, localization, and access documentation. Added external links to official sites for Vite, Shadcn UI, Turbo Repo, and Nitro Mock Server.

Poem

🐰 In the garden of code, we now thrive,
With pnpm install, our apps come alive!
Links sprout like flowers, clear paths to explore,
Each guide a treasure, who could ask for more?
Hopping through docs, with joy we shall sing,
For every new change, brings smiles like spring! 🌷✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8ed2adb and a836b62.

Files selected for processing (2)

• docs/src/guide/in-depth/ui-framework.md (1 hunks)
• docs/src/index.md (1 hunks)

Additional comments not posted (10)

docs/src/guide/in-depth/ui-framework.md (1)

17-17: Documentation Enhancement: Added a crucial step for installing dependencies.

The added instruction to execute pnpm install ensures users properly install dependencies, which is essential for the setup process.

docs/src/index.md (9)

28-29: Improved Navigability: Added link to Quick Start guide.

The link to the Quick Start guide enhances user experience by providing direct access to initial setup instructions.

---

33-34: Improved Navigability: Added link to Configuration documentation.

The link to the Configuration documentation helps users quickly find detailed configuration instructions.

---

38-39: Improved Navigability: Added link to Theme documentation.

The link to the Theme documentation provides users with easy access to theme customization instructions.

---

43-44: Improved Navigability: Added link to Localization documentation.

The link to the Localization documentation allows users to find information on multi-language support quickly.

---

48-49: Improved Navigability: Added link to Access Management documentation.

The link to the Access Management documentation helps users locate information on permission management easily.

---

54-55: Improved Navigability: Added link to Vite official site.

The link to the Vite official site provides users with direct access to detailed information about the Vite build tool.

---

60-61: Improved Navigability: Added link to Shadcn UI official site.

The link to the Shadcn UI official site offers users direct access to more information about the Shadcn UI framework.

---

66-67: Improved Navigability: Added link to Turbo Repo official site.

The link to the Turbo Repo official site provides users with direct access to information about the Turbo Repo tool.

---

72-73: Improved Navigability: Added link to Nitro Mock Server official site.

The link to the Nitro Mock Server official site gives users direct access to detailed information about the Nitro Mock Server.