docs: fix rendering issue

[julienrbrt]

Description

fixes: https://github.com/cosmos/cosmos-sdk-docs/actions/runs/11270564311/job/31341553897

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and structure of the core components documentation for the Cosmos SDK.
  • Introduced a new section on the Custom Header Service for implementing custom logic.
  • Updated sections on BranchService, Event Service, Gas Service, and Header Service to improve understanding of their functionalities.
  • Clarified the Query and Message Router Service to highlight interface implementation for dynamic dispatch.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request includes extensive modifications to the documentation of the Cosmos SDK's core components. Key changes involve the introduction of the Environment struct, updates to the BranchService, and clarifications in the Event Service, Gas Service, and Header Service sections. A new section on the Custom Header Service has been added, along with refinements to the Query and Message Router Service, TransactionService, and KVStore Service sections. The overall structure and clarity of the document have been enhanced to better present the core services and their interfaces.

Changes

File Path	Change Summary
docs/learn/advanced/17-core.md	- Enhanced clarity and structure regarding core components. - Introduced Environment struct replacing sdk.Context. - Updated BranchService for atomic operations. - Refined Event Service to clarify deprecated API mappings. - Added Custom Header Service section. - Clarified Query and Message Router Service interface. - Provided concise descriptions for TransactionService and KVStore Service.

Possibly related PRs

• chore: prepare core 1.0.0-alpha.1 #21564: This PR includes updates related to the core services and introduces new features that enhance the functionality of the Cosmos SDK, which aligns with the changes made in the main PR regarding the core components and services.
• docs: update learn/intro #22046: This PR updates the documentation in the "learn/intro" section, which may relate to the overall organization and clarity improvements seen in the main PR's documentation changes.
• docs(core): create docs for environment and core API #22156: This PR focuses on creating documentation for the core API and the Environment context, which directly relates to the main PR's emphasis on the Environment struct and core services within the Cosmos SDK.

Suggested labels

backport/v0.52.x

Suggested reviewers

• tac0turtle
• facundomedica

---

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
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/learn/advanced/17-core.md (1)

Line range hint 33-46: LGTM! Consider adding a brief explanation of the example.

The new code example effectively demonstrates the use of BranchService.Execute. It provides a practical context for understanding how the Branch Service can be utilized in module logic.

To further enhance clarity, consider adding a brief explanation of what the example is doing, particularly for readers who may not be familiar with the x/epoch module. For instance:

This example demonstrates how the `x/epoch` module uses `BranchService.Execute` in its BeginBlocker to safely perform epoch-related operations. If any error occurs during the execution of `AfterEpochEnd`, all changes will be rolled back, ensuring data consistency.

🧰 Tools

🪛 LanguageTool

[style] ~30-~30: Consider shortening or rephrasing this to strengthen your wording.
Context: ...useful for executing code that needs to make changes to the store, but may need to be rolled ba...

(MAKE_CHANGES)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 910a97a and 5dbba9b.

📒 Files selected for processing (1)

• docs/learn/advanced/17-core.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/learn/advanced/17-core.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"