docs: change build-whatever page to rollup-stacks #1801
Conversation
WalkthroughThe pull request introduces several modifications primarily focused on enhancing the navigation structure and content clarity within the documentation. Key changes include renaming a navigation item from "Build whatever" to "Rollup stacks" and updating associated links. The sidebar configuration has been expanded to include detailed sub-items related to rollup technologies. Additionally, the content of various guides has been refined to improve usability, with updated command examples and a shift in focus towards rollup stacks in multiple documents. Changes
Assessment against linked issues
Possibly related issues
Possibly related PRs
Suggested labels
Poem
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? 🪧 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 (
|
|
jcstein
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
tutorials/integrate-celestia.md (1)
Line range hint
102-102: Consider adding more context to the "Subject to Change" noteThe asterisk note "*Subject to Change" could be more informative by including:
- The current status or version this applies to
- Where users can find the latest information about block times
-*Subject to Change +*Block times are subject to change. Please refer to our [network parameters](../specs/parameters.md) for the latest configuration.how-to-guides/rollup-stacks.md (2)
Line range hint
37-54: Consider documenting future integrations separately.The commented-out entries for Gateway, Lumoz, and Snapchain (Polygon CDK) could be moved to a "Coming Soon" or "Future Integrations" section instead of being commented out in the code.
+ ### Future Integrations + + The following RaaS providers are working on Polygon CDK integration: + - Gateway + - Lumoz + - Snapchain
Line range hint
56-62: Consider adding deployment prerequisites.The Smart contracts section could be enhanced by adding:
- Prerequisites for deploying to these testnets
- Links to example contracts or tutorials
- Information about test tokens or faucets
.vitepress/config.ts (1)
Line range hint
538-673: LGTM! Well-structured organization of rollup documentation.The new sidebar structure effectively organizes rollup-related content into logical categories:
- Clear separation between EVM and Sovereign rollups
- Comprehensive coverage of major solutions (Arbitrum, Astria, Optimism)
- Inclusion of relevant resources, tutorials, and audits for each solution
This organization significantly improves content discoverability and provides a better learning path for users.
Consider adding a "Getting Started" or "Introduction to Rollups" section at the top of the rollup stacks menu to help newcomers understand the basics before diving into specific implementations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.vitepress/config.ts(2 hunks)how-to-guides/quick-start.md(1 hunks)how-to-guides/rollup-stacks.md(1 hunks)tutorials/integrate-celestia.md(1 hunks)
🔇 Additional comments (5)
tutorials/integrate-celestia.md (1)
22-22: LGTM: Link update aligns with documentation restructuring
The change from "Build whatever" to "Rollup stacks" improves clarity and aligns with the broader documentation reorganization effort.
how-to-guides/rollup-stacks.md (3)
Line range hint 1-11: Great improvement in clarity and focus!
The title change from "Build whatever" to "Rollup stacks" and the revised introduction provide much clearer context for developers. This directly addresses the confusion mentioned in issue #1799.
Line range hint 64-186: Excellent educational content structure!
The explanations of rollups, modular blockchains, and their benefits are well-organized and technically accurate. The content successfully bridges the gap between technical concepts and practical applications.
Line range hint 13-35: Verify link consistency and accessibility.
While the visual layout with UrlImageButton components improves navigation, there are some inconsistencies to address:
- Some buttons use
target="_self"while others don't specify a target - External links (like Sovereign SDK) point to GitHub directly
✅ Verification successful
Based on the shell script results, I can now verify the links in the rollup-stacks.md file. Let me generate the final response:
Links are consistent and accessible
The links in the rollup-stacks.md file have been verified:
- Internal links (
/how-to-guides/intro-to-op-stackand/how-to-guides/arbitrum-integration) are valid and exist in the repository - External links to documentation sites (Sovereign SDK, Dymension, Stackr, Rollkit) are accessible and point to valid resources
- The target attribute usage is consistent with the navigation pattern - internal links use
target="_self"while external links don't specify a target, which is the correct behavior for external navigation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify internal links and check for broken external links
# Check internal links
rg -l "(/how-to-guides/|/docs/)" | xargs -I {} sh -c 'echo "Checking {}"; cat {} | grep -o "/how-to-guides/[^\"]*\|/docs/[^\"]*"'
# Check external links (GitHub, documentation sites)
rg -l "(https://github.com/|https://docs\.)" | xargs -I {} sh -c 'echo "Checking {}"; cat {} | grep -o "https://[^\"]*"'
Length of output: 53395
.vitepress/config.ts (1)
236-236: LGTM! Navigation item renamed for better clarity.
The change from "Build whatever" to "Rollup stacks" provides a more precise and professional description of the section's content.
Overview
Resolves #1799
Summary by CodeRabbit
New Features
Documentation
quick-start.mdwith updated commands and references.rollup-stacks.mdto focus on modular blockchains and their benefits for developers.integrate-celestia.mdto clarify the target audience as service providers and revised relevant links.