docs(consensus-node): reduce log level#2002
Conversation
WalkthroughThe documentation for consensus node reset procedures was updated to improve readability by inserting blank lines before bullet lists in three command descriptions. Additionally, a new optional section was added, providing guidance on reducing log verbosity by editing the Changes
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
how-to-guides/consensus-node.md (1)
522-531: Add “Reduce log level” configuration tip
Great addition that directly addresses the PR objective of lowering log verbosity. Consider consolidating all optional configuration tweaks (logging, indexing, pruning, etc.) under a single Configuration options section for better discoverability. Optionally, if your style guide permits, you could switch from adiff-style code block to atoml-highlighted snippet to improve clarity for readers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/consensus-node.md(4 hunks)
🔇 Additional comments (3)
how-to-guides/consensus-node.md (3)
364-364: Consistent Markdown list formatting
Adding a blank line before the list under Option 1: Reset blockchain data withreset-stateimproves readability and aligns with common Markdown style (and markdownlint rules).
380-380: Consistent Markdown list formatting
Adding a blank line before the list under Option 2: Full reset withunsafe-reset-allimproves readability and aligns with Markdown best practices.
415-415: Consistent Markdown list formatting
Adding a blank line before the list under Option 4: Simple data directory cleanup enhances readability and follows Markdown guidelines.
Motivated by celestiaorg/celestia-app#4643
cc: @tac0turtle
Screenshot
Summary by CodeRabbit