Skip to content

docs: fix broken links, stale flag prefixes, and formatting issues - #3112

Merged
alpe merged 2 commits into
marko/docs_rewritefrom
fix/docs-review-fixes
Feb 27, 2026
Merged

docs: fix broken links, stale flag prefixes, and formatting issues#3112
alpe merged 2 commits into
marko/docs_rewritefrom
fix/docs-review-fixes

Conversation

@alpe

@alpealpe commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes the most critical issues found during code review of the docs rewrite:
Disclaimer: 100% AI generated

�� Broken Internal Links

  • forced-inclusion.md: based.mdbased-sequencing.md (2 links)
  • block-lifecycle.md: da.mddata-availability.md (2 links)
  • reference/specs/overview.md: p2p.md../../learn/specs/p2p.md (file doesn't exist in reference/specs/)
  • running-nodes/full-node.md: Fixed relative paths to guides/gm-world.md and guides/evm/single.md

🟡 Stale --rollkit.* Flag Prefixes

  • ev-node-config.md: Replaced all ~40 occurrences of --rollkit.* with --evnode.* to match the actual CLI flags
  • visualizer.md: --rollkit.rpc.enable_da_visualization--evnode.rpc.enable_da_visualization

🟢 Minor Fixes

  • what-is-evolve.md: Removed escaped backticks (\\ev-node\``) that rendered as literal backslashes

…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
@coderabbitai

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/docs-review-fixes

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actionsBot commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

The latest Buf updates on your PR. Results from workflow CI / buf-check (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed⏩ skipped✅ passed✅ passedFeb 27, 2026, 12:53 PM

@codecov

codecovBot commented Feb 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.90%. Comparing base (7b86fed) to head (f60a62c).
⚠️ Report is 1 commits behind head on marko/docs_rewrite.

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 
FlagCoverage Δ
combined60.90% <ø> (-0.06%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…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

@tac0turtletac0turtle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thank you

@alpe
alpe merged commit 1c49f44 into marko/docs_rewriteFeb 27, 2026
25 of 28 checks passed
@alpe
alpe deleted the fix/docs-review-fixes branch February 27, 2026 13:16
@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-02-27 13:17 UTC

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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alpe@tac0turtle