Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(gov): remove stores & proposal processing queue #22143

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

harryMaksim
Copy link
Contributor

@harryMaksim harryMaksim commented Oct 7, 2024

removed in here:deec679#diff-3b932fd329b6630207a4705ca1acf774004af9f6e52b7ae7eba0cba8cbb893c1L433
So I think we should delete the table of the content too.

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity and detail in the Governance module documentation.
    • Expanded sections on proposal submission, voting rights, and deposit handling.
    • Added new proposal types and clarified voting mechanics, including quorum definitions.
    • Improved descriptions of message types and emphasized metadata importance for proposals.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

📝 Walkthrough

Walkthrough

The changes in the x/gov/README.md file involve a comprehensive restructuring and enhancement of the documentation for the Governance module of the Cosmos SDK. The updates provide detailed explanations of the governance process, including proposal submission, voting, and execution. New sections clarify proposal types, voting mechanics, and the concept of the Constitution. The document emphasizes the importance of metadata in proposals and introduces structured formats for clarity.

Changes

File Change Summary
x/gov/README.md Enhanced documentation covering governance processes, proposal types, voting mechanisms, and metadata usage.

Possibly related PRs

  • docs(x/gov): fix typos #21588: This PR focuses on fixing typos in the x/gov/README.md, which is directly related to the main PR that enhances the documentation for the Governance module.
  • docs: update gov docs #22048: This PR updates the governance documentation, including new proposal types and voting mechanisms, which aligns closely with the changes made in the main PR to clarify governance processes.
  • docs: Update slashing docs #22107: This PR updates the slashing documentation, which may not be directly related but is part of the broader context of governance and proposal handling within the Cosmos SDK.
  • docs: pre,begin,end block #22127: This PR addresses documentation changes related to the "pre," "begin," and "end" blocks, which are relevant to the governance process and its lifecycle.
  • docs: fix several typos in the document  #22135: This PR focuses on fixing typos in various documents, including those related to governance, enhancing overall clarity and professionalism in the documentation.

Suggested labels

C:x/gov, backport/v0.52.x

Suggested reviewers

  • sontrinh16
  • julienrbrt

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bbff2c8 and 34d3dec.

📒 Files selected for processing (1)
  • x/gov/README.md (0 hunks)
💤 Files with no reviewable changes (1)
  • x/gov/README.md

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 7, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@julienrbrt julienrbrt added this pull request to the merge queue Oct 7, 2024
Merged via the queue into cosmos:main with commit cc25229 Oct 7, 2024
71 of 76 checks passed
mergify bot pushed a commit that referenced this pull request Oct 7, 2024
julienrbrt pushed a commit that referenced this pull request Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/gov
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants