warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.09k stars 96 forks source link

Docs fixes #478

Closed ijonele closed 3 days ago

ijonele commented 3 days ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago

[!WARNING]

Rate limit exceeded

@ijonele has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 17 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between b510af79fb417af4b59eadf6ab813776d3d8f864 and e2e91ae7c4a7ff1f479ba3ff9789ad409f090853.

Walkthrough

The recent changes enhance clarity, organization, and consistency in the Warden Protocol's documentation. These improvements span multiple files, addressing grammar, terminology, and formatting. Additions include new contribution guidelines and fine-tuning specific descriptions related to features and processes. While the core functionality remains unchanged, these updates significantly improve the user experience and understanding of the Warden Protocol and its associated components.

Changes

Files Change Summary
README.md Rephrasing and restructuring content for clarity and organization without altering the core functionality or logic.
docs/.spelling Addition of various terms related to WardenUI, WardenJS, Area-52, IBC-Go, and specific messages and entities.
docs/README.md Update of content organization, installation instructions, and additional features like spellcheck guidance.
docs/docs/build-an-oapp/introduction.md Correction of grammatical error.
docs/docs/help-center/enable-metamask-snap.md Update to emphasize the testnet phase and transition to the standard MetaMask extension.
docs/docs/help-center/use-walletconnect.md Typo correction ("Cick" to "Click").
docs/docs/learn/glossary.md Refinement of descriptions related to upcoming features and AI-driven Agents.
docs/docs/learn/introduction-to-warden.md Refinement of the interoperability feature description.
docs/docs/learn/request-flow.md Consistent terminology update (changing "P2P-network" to "P2P network").
docs/docs/learn/warden-protocol-modules/x-warden.md Typo corrections ("adresses" to "addresses" and "siganture" to "signature").
docs/docs/operate-a-node/create-a-validator.md Semantic adjustment in instructions for getting the public address.
protocol-developer-docs/1-report-issues.md Refinement of instructions for submitting issues and emphasizing the importance of a detailed description.
protocol-developer-docs/2-contribute-code.md Introduction of guidelines for contributing to the Warden Protocol codebase.
protocol-developer-docs/5-shorthands.md Minor revision in the explanation of emojis used in code-review comments and chats.
`protocol-developer-docs/architectural-decision-records/... Renaming ADR title and adjusting corresponding heading.
protocol-developer-docs/architectural-decision-records/... | Update of link in the markdown file fromcreate-an-adr.mdto1-create-an-adr.md`.
`protocol-developer-docs/architectural-decision-records/... Updating titles and links within the document related to ADRs in the Warden Protocol. Specifically, restructuring the introduction section and modifying links to ADR creation resources.

Sequence Diagram(s)

Silent ignore as per instruction due to the nature of the changes.


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 There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.