sync docs md files

[EzrealJ]

sync docs md files from docs repo

Summary by CodeRabbit

• New Features

  • Added quick start guide, API interaction attributes, special parameter types, data validation, advanced features, auth token extension, Json.NET extension, JsonRpc support, and OpenAPI-to-code tool documentation for WebApiClientCore.

• Documentation

  • Updated and clarified various guides and markdown files related to API definitions, request handling, validation, and advanced configurations.
  • Translated and rephrased content to improve readability and consistency.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The recent updates encompass various new guides and enhancements across multiple files for WebApiClientCore, including quick start guides, attributes for API interaction, and advanced features such as validation, OAuth token handling, and JSON serialization. These changes introduce new interfaces and methods, enhance existing documentation by rephrasing and updating sections, and improve the overall developer experience by providing comprehensive examples and usage scenarios.

Changes

Files	Change Summary
docs/guide/1_getting-started.md	Added a quick start guide for WebApiClientCore in .NET with details on dependencies and setup.
docs/guide/2_attributes.md	Introduced attributes for API interaction and their role in request-response handling.
docs/guide/3_special-type.md	Described special parameter types for API requests without explicit decoration.
docs/guide/4_data-validation.md	Explained validation for request parameters and response results using ValidationAttribute.
docs/guide/5_advanced.md	Covered advanced features like URI handling, retries, request signing, and custom filters.
docs/guide/6_auth-token-extension.md	Introduced OAuth token extension for managing token retrieval and application.
docs/guide/7_json-net-extension.md	Provided JSON serialization using Json.NET with optional configuration settings.
docs/guide/8_jsonrpc-extension.md	Emphasized JsonRpc support with method and parameter decorations using WebApiClientCore.Extensions.JsonRpc.
docs/guide/9_openapi-to-code.md	Introduced a tool for generating interface definitions from OpenAPI documents.
docs/guide/readme.md	Updated summaries and structure for WebApiClient and WebApiClientCore.
docs/old/advanced/... - README, others	Made semantic and structural adjustments for better consistency and readability across older documents.
docs/qa.md	Translated headings and content to Chinese, updated explanations about proxy validation and synchronous requests.

Poem

Amid .NET's fields where code does bloom,
We've crafted guides to ease your gloom.
From tokens swift to Json dreams,
Your APIs now gleam with beams.
Validation strong, attributes set right,
Dive in deep, code the night.
A rabbit’s joy in bytes and strings,
For every dev, the future brings.

(\_/)
(^.^)
()_(")

---

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