docs(consensus): enhance README with comprehensive module documentation

[avorylli]

Improve x/consensus README.md with:

• Clear module overview and purpose
• Detailed parameter descriptions
• Usage examples with code snippets
• Architecture and security information
• Better structure for contributors and users

This makes the module more discoverable and easier to understand
for developers working with consensus parameters.

Summary by CodeRabbit

• Documentation
  • Expanded README with an on-chain governance overview for updating consensus parameters.
  • Clarified parameter categories (Block, Evidence, Validator, ABCI) and their configurable fields.
  • Added step-by-step examples for submitting parameter update proposals and querying current parameters.
  • Included high-level architecture and security considerations, covering authorization, validation, and governance approval.
  • Documentation-only change; no code or API modifications.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation-only update: expanded x/consensus README from a single-line description to a detailed, governance-focused guide covering parameter categories, usage (MsgUpdateParams), queries, architecture components, and security constraints. No code or API changes.

Changes

Cohort / File(s)	Summary of Changes
Docs: Governance-focused consensus params README x/consensus/README.md	Rewrote README to detail on-chain governance updates for consensus parameters (Block, Evidence, Validator, ABCI), usage example (MsgUpdateParams), parameter query, architecture (Keeper/Types/Module), and security constraints. No code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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.

CodeRabbit Configuration 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[coderabbitai]

Actionable comments posted: 4

🧹 Nitpick comments (3)

x/consensus/README.md (3)

36-38: Add ABCI param example (VoteExtensionsEnableHeight).

Since ABCI params are documented above, include them in the usage snippet for completeness.

     Validator: &types.ValidatorParams{
         PubKeyTypes: []string{"ed25519"},
     },
+    Abci: &types.ABCIParams{
+        VoteExtensionsEnableHeight: 123456,
+    },

Also applies to: 45-61

---

28-33: Document cross-constraint: Evidence.MaxBytes must not exceed Block.MaxBytes.

Prevents invalid configurations.

 - `MaxBytes`: Maximum evidence size in bytes
+
+> Note: Evidence.MaxBytes must be ≤ Block.MaxBytes.

---

79-82: Grammar nit.

- - Updates are subject to governance approval process
+ - Updates are subject to the governance approval process.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between b6b58e4 and c3f4377.

📒 Files selected for processing (1)

• x/consensus/README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

x/consensus/README.md

[grammar] ~25-~25: There might be a mistake here.
Context: ... MaxBytes: Maximum block size in bytes - MaxGas: Maximum gas per block ### Evidence Pa...

(QB_NEW_EN)

---

[grammar] ~29-~29: There might be a mistake here.
Context: ...ocks: Maximum age of evidence in blocks - MaxAgeDuration: Maximum age of evidence in time - Max...

(QB_NEW_EN)

---

[grammar] ~30-~30: There might be a mistake here.
Context: ...ration: Maximum age of evidence in time - MaxBytes`: Maximum evidence size in bytes ### Va...

(QB_NEW_EN)

---

[grammar] ~73-~73: There might be a mistake here.
Context: ...Manages parameter storage and validation - Types: Defines message types and param...

(QB_NEW_EN)

---

[grammar] ~74-~74: There might be a mistake here.
Context: ...s message types and parameter structures - Module: Integrates with the Cosmos SDK...

(QB_NEW_EN)

---

[grammar] ~81-~81: There might be a mistake here.
Context: ...efore application - Updates are subject to governance approval process

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Summary

[aljo242]

@technicallyty to review when he returns

[technicallyty]

i think we should apply most of the coderrabbit's suggestions

[technicallyty]

one more thing then should be good to go

[technicallyty]

awesome thank you