Modify how to guide arrangement

[Manav-Aggarwal]

Overview

Modify how to guide arrangement lightly

Summary by CodeRabbit

• New Features

  • Introduced a reorganized sidebar navigation with a new "How To Guides" section, featuring five new entries for enhanced user guidance.
  • Restructured the "Integrations" section for improved clarity and organization.

• Documentation

  • Updated the prerequisites in the zkML guide to reflect a broader context of EVM usage, linking to the beaconkit tutorial instead of the Polaris EVM.

[coderabbitai]

Walkthrough

The pull request introduces significant changes to the sidebar navigation structure in the .vitepress/config.ts file and updates the prerequisites in the guides/zkml.md document. The sidebar now features a reorganized "How To Guides" section with new entries and a refined "Integrations" section. Additionally, the prerequisites in the guides/zkml.md have been generalized to broaden the context of EVM usage.

Changes

File	Change Summary
.vitepress/config.ts	Modified the sidebarHome function to replace and reorganize sidebar items, adding new entries under "How To Guides" and restructuring the "Integrations" section.
guides/zkml.md	Updated the prerequisites section to refer to "EVM" instead of "Polaris EVM" and changed the link to point to beaconkit.md.

Possibly related PRs

• Minor updates to Wordle #373: Modifies the sidebar navigation in .vitepress/config.ts, related to the main PR's sidebar changes.
• Minor updates to learn section #379: Involves restructuring sidebar items in .vitepress/config.ts, directly connected to the main PR.
• move using tia for gas to guides #387: Adds a new sidebar item in .vitepress/config.ts, aligning with the main PR's focus.
• Update to use rollkit cli instead of <binary>d #394: Updates the sidebar navigation in .vitepress/config.ts, relevant to the main PR's changes.
• chore: update celestia-da.md #396: Updates tutorials/celestia-da.md, which may relate to guides in the sidebar restructuring.
• Use rollkit cli for use-tia-for-gas how-to #426: Focuses on using the Rollkit CLI in documentation, aligning with the main PR's guide accessibility improvements.
• docs: update celestia-da for changes on GM #438: Updates the Celestia documentation, which may relate to guides mentioned in the sidebar restructuring.

Suggested labels

documentation

Poem

🐇 In the garden of guides, we hop and play,
With new paths to follow, brightening the way.
The sidebar now sings with a clearer tune,
As we explore the EVM under the moon.
Hooray for the changes, let’s cheer and delight,
For every new guide makes our knowledge take flight! 🌟

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-443/
on branch main at 2024-09-09 09:05 UTC

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

.vitepress/config.ts (1)

269-288: Missing Links in Sidebar Configuration

Several links in the sidebar configuration do not correspond to existing markdown files in the documentation. This could result in broken links on the site. Please verify the following links to ensure they are correct or create the necessary markdown files:

• /guides/use-rollkit-cli
• /guides/connect-local-da
• /guides/restart-rollup
• /guides/full-and-sequencer-node
• /guides/cw-orch
• /guides/zkml
• /guides/ibc-connection
• /guides/rollkit-monitoring
• /guides/use-tia-for-gas

Analysis chain

Approve the sidebar changes with a suggestion to verify links.

The modifications to the sidebarHome function introduce new entries under "How To Guides" and "Integrations" which are well-organized and should improve user navigation. The changes are consistent with the PR objectives to enhance the layout and presentation of the guides.

However, it's crucial to ensure that all new links are valid and lead to the correct guides. This verification is essential to prevent navigation errors on the live site.

Run the following script to verify the links in the sidebar:

Also applies to: 316-337

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all links in the sidebar to ensure they are valid.

# Test: Search for the links in the documentation directory. Expect: All links should exist.
rg --type markdown -l $'/guides/use-rollkit-cli|/guides/connect-local-da|/guides/create-genesis|/guides/restart-rollup|/guides/full-and-sequencer-node|/guides/cw-orch|/guides/zkml|/guides/ibc-connection|/guides/rollkit-monitoring|/guides/use-tia-for-gas'

Length of output: 466

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0dbedd2 and 62cbe8f.

Files selected for processing (2)

• .vitepress/config.ts (2 hunks)
• guides/zkml.md (1 hunks)

Files skipped from review due to trivial changes (1)

• guides/zkml.md

[jcstein]

utACK