docs: fix broken links, stale flag prefixes, and formatting issues#3112
Merged
alpe merged 2 commits intomarko/docs_rewritefrom Feb 27, 2026
Merged
docs: fix broken links, stale flag prefixes, and formatting issues#3112alpe merged 2 commits intomarko/docs_rewritefrom
alpe merged 2 commits intomarko/docs_rewritefrom
Conversation
…backticks - Fix forced-inclusion.md: based.md → based-sequencing.md (2 links) - Fix block-lifecycle.md: da.md → data-availability.md (2 links) - Fix reference/specs/overview.md: p2p.md → learn/specs/p2p.md - Fix running-nodes/full-node.md: relative paths to guides/ - Fix what-is-evolve.md: remove escaped backticks around ev-node - Replace all --rollkit.* flags with --evnode.* in ev-node-config.md - Fix visualizer.md: --rollkit.rpc → --evnode.rpc
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
|
The latest Buf updates on your PR. Results from workflow CI / buf-check (pull_request).
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## marko/docs_rewrite #3112 +/- ##
======================================================
- Coverage 60.95% 60.90% -0.06%
======================================================
Files 113 113
Lines 11617 11617
======================================================
- Hits 7081 7075 -6
- Misses 3738 3743 +5
- Partials 798 799 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…012 extra blank lines) - Add 'text' language specifier to 25 fenced code blocks containing ASCII diagrams, log output, and formulas - Remove extra blank line in migration-from-cometbft.md - Fix non-descriptive link text in deployment.md
Contributor
|
tac0turtle
added a commit
that referenced
this pull request
Mar 2, 2026
* rewrite and restructure docs * refernce and change of sequencing concept * Refactor documentation for data availability layers and node operations - Updated Celestia guide to clarify prerequisites, installation, and configuration for connecting Evolve chains to Celestia. - Enhanced Local DA documentation with installation instructions, configuration options, and use cases for development and testing. - Expanded troubleshooting guide with detailed diagnostic commands, common issues, and solutions for node operations. - Created comprehensive upgrades guide covering minor and major upgrades, version compatibility, and rollback procedures. - Added aggregator node documentation detailing configuration, block production settings, and monitoring options. - Introduced attester node overview with configuration and use cases for low-latency applications. - Removed outdated light node documentation. - Improved formatting and clarity in ev-reth chainspec reference for better readability. * format * claenup and comments * Update block-lifecycle.md * adjustments * docs: fix broken links, stale flag prefixes, and formatting issues (#3112) * docs: fix broken links, stale --rollkit.* flag prefixes, and escaped backticks - Fix forced-inclusion.md: based.md → based-sequencing.md (2 links) - Fix block-lifecycle.md: da.md → data-availability.md (2 links) - Fix reference/specs/overview.md: p2p.md → learn/specs/p2p.md - Fix running-nodes/full-node.md: relative paths to guides/ - Fix what-is-evolve.md: remove escaped backticks around ev-node - Replace all --rollkit.* flags with --evnode.* in ev-node-config.md - Fix visualizer.md: --rollkit.rpc → --evnode.rpc * docs: fix markdownlint errors (MD040 missing code block languages, MD012 extra blank lines) - Add 'text' language specifier to 25 fenced code blocks containing ASCII diagrams, log output, and formulas - Remove extra blank line in migration-from-cometbft.md - Fix non-descriptive link text in deployment.md * fix and push --------- Co-authored-by: Alexander Peters <alpe@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the most critical issues found during code review of the docs rewrite:
Disclaimer: 100% AI generated
�� Broken Internal Links
based.md→based-sequencing.md(2 links)da.md→data-availability.md(2 links)p2p.md→../../learn/specs/p2p.md(file doesn't exist in reference/specs/)guides/gm-world.mdandguides/evm/single.md🟡 Stale
--rollkit.*Flag Prefixes--rollkit.*with--evnode.*to match the actual CLI flags--rollkit.rpc.enable_da_visualization→--evnode.rpc.enable_da_visualization🟢 Minor Fixes
\\ev-node\``) that rendered as literal backslashes