search

mycel-labs / mycel-docs

https://docs.mycel.land
1 stars 0 forks source link

update transferable-account.md #50

Closed peaceandwhisky closed 2 months ago

peaceandwhisky commented 2 months ago

Summary by CodeRabbit

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mycel-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 24, 2024 9:46am
coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates focus on refining Mycel's documentation and configuration. Key changes include marking several documents as drafts, updating governance and validation descriptions, and introducing new concepts like Transferable Accounts. The project's branding and configuration have also been updated to reflect the shift from an "ID Based Intent-Centric Interface" to an "Account Transfer Protocol." Additionally, memory requirements for Mycel nodes have been increased.

Changes

Files Change Summary
.eslintcache Updated file sizes, modification timestamps, and configuration details.
docs/develop/cli.md, .../index.md, .../network.md Added draft: true to front matter.
docs/overview/concepts/index.md Removed detailed explanations and images, focusing on a concise overview.
docs/overview/concepts/mycel-id.md Updated sidebar_position and added draft: true in the front matter.
docs/overview/concepts/transferable-account.md Introduced the concept of Transferable Accounts in Mycel.
docs/overview/governance/index.md, .../validate/index.md Refined descriptions of governance and validator responsibilities.
docs/overview/grossary.md Added a section on "Intents" with explanations, examples, and diagrams.
docs/overview/index.md Significantly altered content to focus on Mycel as a decentralized platform for account transfer and management.
docs/overview/roadmap.md Removed specific release details and timelines, providing a general overview.
docs/overview/what_to_build.md Introduced guidelines for building a decentralized OTC market for transferable accounts.
docs/validate/setup.md Updated memory requirement for a Full Node from 8GB to 16GB.
docusaurus.config.js Updated title, URL, and organization name to reflect new branding.
src/components/Hero.tsx Changed text content to "Account Transfer Protocol."
src/pages/index.tsx Removed sections related to various features and updated descriptions and icons for remaining sections.

🐰 In the world of code, where changes flow, Mycel's docs now clearly show, Transferable accounts, intents anew, A protocol fresh, for all to view. With nodes that need a bit more space, We hop ahead, a steady pace. 🌱

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