Skip to content

refactor: refactor docs with vitepress#2

Merged
kagol merged 3 commits intomainfrom
kagol/refactor-docs-with-vitepress
Aug 13, 2024
Merged

refactor: refactor docs with vitepress#2
kagol merged 3 commits intomainfrom
kagol/refactor-docs-with-vitepress

Conversation

@kagol
Copy link
Member

@kagol kagol commented Aug 13, 2024

效果如下:

image

查看源代码:

image

Summary by CodeRabbit

  • New Features

    • Updated local development server URL in documentation for easier access.
    • Introduced comprehensive guides for quick setup and basic usage of the FluentEditor.
    • Added a structured sidebar for improved navigation in the documentation.
  • Documentation

    • Enhanced the README files with updated URLs and translated sections.
    • Added documentation files outlining key features and usage examples for FluentEditor.
  • Chores

    • Updated repository settings to ignore cache files for cleaner version control.
    • Transitioned build and development scripts from Vite to VitePress for documentation-centric workflows.

@coderabbitai
Copy link

coderabbitai bot commented Aug 13, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This update significantly enhances the FluentEditor documentation by introducing new configuration files, refining sidebar navigation, and revamping the README. The transition from Vite to VitePress provides a more structured documentation site, improving user guidance. New components and demos showcase the editor's capabilities, facilitating a smoother onboarding experience for users.

Changes

File Path Change Summary
.gitignore Added cache to ignore temporary files.
README.md, README.zh-CN.md Updated URL from http://localhost:5173/ to http://localhost:5173/fluent-editor/.
packages/docs/fluent-editor/.vitepress/config.ts, theme/index.ts, sidebar.ts Introduced new configuration files for VitePress, defining metadata, theme, and sidebar structure.
packages/docs/fluent-editor/demos/basic-usage.vue, docs/basic-usage.md, docs/quick-start.md, index.md Added new Vue component and documentation sections for basic usage and quick start guide.
packages/docs/fluent-editor/vite.config.ts New Vite configuration file integrating viteDemoPreviewPlugin.
packages/docs/package.json Updated scripts to transition from Vite to VitePress; modified dependencies accordingly.

Poem

🐇 In the garden of code, we hop with glee,
New paths are carved, as bright as can be!
From Vite to VitePress, our journey unfolds,
With demos and guides, new stories are told.
So let’s twirl in the code, let’s dance in delight,
For every new change brings a future so bright! 🌟


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

@kagol kagol merged commit e2d1cbd into main Aug 13, 2024
@kagol kagol deleted the kagol/refactor-docs-with-vitepress branch October 22, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant