chore: remove cli docs#2217
Conversation
|
Warning Rate limit exceeded@tac0turtle has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 11 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
WalkthroughThis set of changes removes the CLI documentation generation feature and its related tooling from the project. Specifically, it deletes the documentation generation command from the CLI, eliminates the associated code, removes documentation markdown files for CLI commands, and updates automation scripts and workflows to stop generating and linting CLI documentation. Indirect dependencies used solely for documentation generation are also removed from Go module files. Additionally, minor formatting adjustments are made to several markdown files, but no functional code or public interfaces are otherwise altered. Changes
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 (
|
RollkitBot
requested review from
a team,
gupadhyaya,
tuxcanfly and
yarikbratashchuk
and removed request for
a team
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2217 +/- ##
==========================================
+ Coverage 40.61% 40.65% +0.04%
==========================================
Files 48 48
Lines 4555 4555
==========================================
+ Hits 1850 1852 +2
+ Misses 2494 2492 -2
Partials 211 211 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The latest Buf updates on your PR. Results from workflow CI and Release / buf-check (pull_request).
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
rollups/evm/based/README.md (1)
19-21: Ensure consistent code-block indentation.While the Build and Init blocks are now indented four spaces under their list items, the Start block remains at two spaces. Consider aligning all fenced code blocks at the same indent level (e.g., four spaces) for uniform nesting and rendering.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
go.sumis excluded by!**/*.sumrollups/evm/based/go.sumis excluded by!**/*.sumrollups/evm/single/go.sumis excluded by!**/*.sumrollups/testapp/go.sumis excluded by!**/*.sum
📒 Files selected for processing (29)
.github/workflows/lint.yml(0 hunks)README.md(2 hunks)docs/cmd/testapp.md(0 hunks)docs/cmd/testapp_completion.md(0 hunks)docs/cmd/testapp_completion_bash.md(0 hunks)docs/cmd/testapp_completion_fish.md(0 hunks)docs/cmd/testapp_completion_powershell.md(0 hunks)docs/cmd/testapp_completion_zsh.md(0 hunks)docs/cmd/testapp_docs-gen.md(0 hunks)docs/cmd/testapp_init.md(0 hunks)docs/cmd/testapp_node-info.md(0 hunks)docs/cmd/testapp_start.md(0 hunks)docs/cmd/testapp_unsafe-clean.md(0 hunks)docs/cmd/testapp_version.md(0 hunks)go.mod(0 hunks)pkg/cmd/docs_gen.go(0 hunks)rollups/evm/based/README.md(1 hunks)rollups/evm/based/go.mod(0 hunks)rollups/evm/based/main.go(0 hunks)rollups/evm/single/README.md(1 hunks)rollups/evm/single/go.mod(0 hunks)rollups/evm/single/main.go(0 hunks)rollups/testapp/go.mod(0 hunks)rollups/testapp/kv/README.md(1 hunks)rollups/testapp/main.go(0 hunks)scripts/utils.mk(2 hunks)specs/lazy-adr/adr-010-exec-api.md(1 hunks)specs/lazy-adr/adr-012-fully-decentralized-based-sequencing.md(3 hunks)specs/lazy-adr/adr-019-forced-inclusion-mechanism.md(2 hunks)
💤 Files with no reviewable changes (21)
- rollups/evm/single/main.go
- go.mod
- rollups/testapp/main.go
- rollups/testapp/go.mod
- rollups/evm/based/go.mod
- docs/cmd/testapp_completion.md
- docs/cmd/testapp_completion_bash.md
- .github/workflows/lint.yml
- docs/cmd/testapp_docs-gen.md
- rollups/evm/single/go.mod
- docs/cmd/testapp_completion_fish.md
- docs/cmd/testapp_version.md
- docs/cmd/testapp_unsafe-clean.md
- docs/cmd/testapp_completion_powershell.md
- docs/cmd/testapp.md
- docs/cmd/testapp_init.md
- docs/cmd/testapp_start.md
- pkg/cmd/docs_gen.go
- docs/cmd/testapp_completion_zsh.md
- rollups/evm/based/main.go
- docs/cmd/testapp_node-info.md
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: rollkit-docker / docker-build (GHCR; ghcr.io/rollkit/rollkit)
- GitHub Check: Analyze (go)
- GitHub Check: test / Run Unit Tests
- GitHub Check: test / Build All Rollkit Binaries
- GitHub Check: Summary
🔇 Additional comments (13)
specs/lazy-adr/adr-010-exec-api.md (1)
168-168: Clean formatting: removed trailing whitespaceRemoving the extraneous blank line with trailing whitespace in the Mermaid sequence diagram improves documentation hygiene and avoids potential rendering inconsistencies. No functional impact.
scripts/utils.mk (1)
18-18: Change ensures proper linting after CLI docs removalThis change removes the
./cmd/rollkit/docs/*.mdpath from the markdownlint ignore list, which aligns with the PR's objective of removing CLI documentation. Now that the CLI docs are being removed, there's no need to exclude this directory from linting checks.This ensures any remaining or future markdown files in this location will be properly linted according to the project's standards.
Also applies to: 34-34
specs/lazy-adr/adr-019-forced-inclusion-mechanism.md (2)
192-232: Explicit ASCII code block specifier improves clarity and rendering.Labeling the first diagram with
asciimakes the intended formatting clear to the markdown processor and readers, preventing generic rendering issues.
238-297: Consistent ASCII art block specification.The second diagram is also explicitly marked as
ascii, ensuring both flowcharts are rendered uniformly and as intended.specs/lazy-adr/adr-012-fully-decentralized-based-sequencing.md (3)
162-163: Consistent bullet formatting in the Rollup Light Clients sectionThe leading asterisks have been removed and the list now uniformly uses hyphens (
-), matching the style of other Markdown lists in this ADR.
180-182: Clean up VerifyBatch use-case list formattingThe VerifyBatch use-cases now consistently use hyphenated bullets without extra leading characters, aligning with the rest of the document’s list style.
186-186: Uniform list style for the Testing bulletThe Testing entry was updated to use a single hyphen bullet, which keeps the list formatting consistent across all VerifyBatch use-cases.
rollups/testapp/kv/README.md (1)
5-5: Heading level update is correct.Changing the “Server Lifecycle” heading from
###to##properly elevates it to a top-level section under the main title, improving document structure and readability.rollups/evm/single/README.md (3)
19-21: Approve: Indented build code block.Indenting the build instructions by four spaces keeps the fenced block nested under the list item and consistent with other rollup docs.
25-27: Approve: Indented init code block.The initialization code block is now correctly indented to align with the Build step formatting.
31-38: Approve: Indented start code block.The start sequencer instructions are consistently indented, matching the Build and Init blocks.
README.md (2)
21-22: Approve: Clarified TestApp description.Splitting the TestApp description into two lines improves readability and concisely emphasizes its role as a reference CLI implementation.
49-51: Approve: Reflowed “Building with Rollkit” text.Moving the reference-implementation sentence to its own line enhances the logical flow under “Building with Rollkit” without altering meaning.
2 participants
Overview
this pr removes the cli docs as its specific to testapp and user apps could contain different cmds not covered here
this pr also fixes buf check ci job
Summary by CodeRabbit
Summary by CodeRabbit
Chores
Documentation