warden-protocol / wardenprotocol

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

feat(docs): Docs site restructure and new content #468

Closed ijonele closed 3 days ago

ijonele commented 3 days ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago
Walkthrough ## Walkthrough The changes encompass updates to documentation links for clarity and consistency, the introduction of new documentation files covering a wide array of topics, and significant semantic updates to existing files. These revisions simplify navigation, enhance understanding, and refine terminology related to smart contracts and key management within the Warden Protocol. ## Changes | File Path | Change Summary | |----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | `README.md` | Updated documentation and protocol developer docs links for clarity. | | `docs/.spelling` | Refined naming conventions for functions and entities to enhance clarity. | | `docs/Overview.md` | Shifted focus from an intent-centric blockchain to a modular L1 blockchain for Omnichain Apps. | | `docs/README.md` | Renamed sections to improve clarity and updated deployment instructions. | | `.../examples/_category_.json` | Introduced a JSON configuration object for examples category properties. | | `.../examples/clichain.md` | Added a placeholder entry titled "clichain" indicating future content. | | `.../examples/warden-kms.md` | Added a placeholder for `WardenKMS` with a note indicating it's coming soon. | | `.../examples/introduction.md` | Introduced the concept of Keychains and explained their role in Warden's security framework. | | `.../examples/keychain-sdk.md` | Detailed the Keychain SDK's functionalities and offered a guide on exploring it. | | `.../examples/quick-start.md` | Provided a guide on building a Keychain using the Keychain SDK. | | `.../build-a-custom-smart-contract.md` | Added a placeholder for building custom smart contracts with emphasis on Approval Rules. | | `.../build-the-frontend/_category_.json` | Introduced a JSON configuration for building an OApp frontend. | | `.../build-the-frontend/quick-start.md` | Added a placeholder titled "Quick start" indicating upcoming content. | | `.../build-the-frontend/wardenjs-functions.md` | Introduced WardenJS functions with a link to the API reference and overview information. | | `.../build-the-frontend/wardenui-components.md` | Added a placeholder for WardenUI components, with future code examples planned. | | `.../build-with-wardenjs.md` | Added a placeholder for building with WardenJS, focusing on modules like Spaces and Keychains. | | `.../introduction.md` | Introduced the concept of Omnichain Applications with guidelines for backend and frontend development. | | `.../quick-start.md` | Provided a beginner’s guide to setting up the environment and building with CosmWasm. | | `.../smart-contract-api-reference.md` | Added a placeholder for a smart contract API reference, indicating future content. | | `.../test/_category_.json` | Introduced a JSON configuration for the test category. | | `.../test/run-a-keychain-from-cli.md` | Detailed semantic changes in CLI instructions for managing keychains and transactions. | | `.../test/run-a-local-chain.md` | Refined the setup and instructions for running a local chain using the Warden Protocol. | | `.../help-center/buenavista-quick-start.md` | Added a quick start guide for Buenavista on SpaceWard, covering creating wallets, getting test WARD, and more. | | `.../help-center/connect-your-wallet.md` | Provided a guide on connecting a Cosmos wallet to a Warden account in SpaceWard. | | `.../help-center/create-a-space.md` | Outlined instructions for creating a Space within SpaceWard. | | `.../help-center/enable-metamask-snap.md` | Introduced a guide on enabling the MetaMask Snap feature. | | `.../learn/warden-protocol-modules/x-warden.md` | Detailed the `x/warden` Cosmos SDK module, adding multiple new messages for space and keychain management. | | `.../learn/whitepaper.md` | Updated the whitepaper content and link, with added notifications about ongoing revisions. | | `.../operate-a-node/create-a-validator.md` | Provided a step-by-step guide for setting up a validator on the Buenavista testnet. | | `.../operate-a-node/delegation-plan.md` | Detailed a plan for delegating tokens to validators within the Warden Protocol. | | `.../wards-token/airdrop-stages.md` | Updated information on the $WARD airdrop's initial snapshot and stages, with a section on checking airdrop status and claiming procedures. |

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.