docs: Documentation based on Vitepress

Ares-Chang commented 10 months ago

此 PR 包含基于 Vitepress 的文档内容更新。

close #44

Summary by CodeRabbit

Documentation
- Added comprehensive guides for using uni-network features, including cancellation, composition API, enhancements, error handling, interceptors, and TypeScript support.
- Introduced API guides for HTTP requests and default configuration practices.
- Provided quick start instructions, instance creation details, and response schema explanations.
- Included build configuration instructions for vue-cli + vue2 and vite + vue3 setups.
- Acknowledged contributions and compared HTTP request libraries in the ecosystem.
New Features
- Implemented a new home layout for the Uni Network documentation with a hero section and feature list.
Chores
- Updated .gitignore to exclude the cache directory for Vitepress.

coderabbitai[bot] commented 10 months ago

Walkthrough

The update encompasses the creation of a Vitepress documentation site for the Uni Network project, introducing a comprehensive suite of documentation files. These files cover a myriad of topics ranging from advanced features like cancellation and error handling to guides on API usage and quick start instructions. The .gitignore file has also been updated to exclude the cache directory used by Vitepress.

Changes

File Path	Change Summary
`.gitignore`	Added exclusion for `cache` directory
`docs/.vitepress/config.ts` `docs/index.md`	Configured Vitepress site and home layout
`docs/advanced/...` `docs/guide/...`	Introduced docs for advanced features, API usage, request/response handling, and TypeScript support
`docs/other/...`	Added build instructions, acknowledgments, and library comparisons

Assessment against linked issues

Objective	Addressed	Explanation
Creation of a Vitepress documentation site (#44)	✅	-

Poem

In the burrow of code, a site is born, 🌱
With docs and guides, no reader forlorn. 📚
A rabbit’s work, through lines of prose,
To light the path where knowledge grows. 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - You can directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging `@coderabbitai` in a comment. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - You can tag `@coderabbitai` in a PR comment and ask questions about the PR and the codebase. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.` - `@coderabbitai read the files in the src/scheduler package and generate README in the markdown format.` 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. ### 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

ModyQyW commented 10 months ago

非常感谢！过年前我争取再修订一下文档然后上线！

uni-helper / uni-network