Add more how-to guides to prepare for next release cycle

[Sipher]

Summary by CodeRabbit

• New Features

  • Introduced a "Stake your Torus" guide to help users stake and allocate Torus tokens.
  • Added a "Become a Root Agent" guide detailing the application process for Root Agent status.
  • Launched a Clickable Image component for interactive image viewing in documentation.

• Enhancements

  • Updated how-to guides ("Register an Agent", "Bridge to Base", "Setup a Wallet") for improved clarity, structure, and visual presentation using the new Clickable Image component and additional images.
  • Sidebar navigation now includes direct links to new how-to guides.

• Documentation

  • Added a "Suggestions" section to the demand signaling documentation with best practices and tips.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces two new how-to guides—"Stake your Torus" and "Become a Root Agent"—and adds them to the documentation sidebar. It also debuts a ClickableImage Astro component, refactors several existing guides to use this component for interactive image display, and enhances content clarity and navigation throughout the how-to documentation.

Changes

File(s)	Change Summary
astro.config.mjs	Standardized import quotes; added "Stake your Torus" and "Become a Root Agent" to the sidebar under "How-to Guides".
src/components/ClickableImage.astro	Introduced a new Astro component for clickable images with modal enlargement, keyboard and click-to-dismiss support, and styling.
src/content/docs/how-to-guides/become-a-root-agent.mdx src/content/docs/how-to-guides/stake-your-torus.mdx	Added two new comprehensive how-to guides: one for staking Torus tokens and another for becoming a Root Agent, including step-by-step instructions and visual aids.
src/content/docs/how-to-guides/bridge-to-base.mdx src/content/docs/how-to-guides/register-an-agent.mdx src/content/docs/how-to-guides/setup-a-wallet.mdx	Refactored guides to use the new ClickableImage component for all images; updated and clarified instructions, improved formatting, and enhanced interactivity and visual presentation.
src/content/docs/agents/demand-signaling.mdx	Added a "Suggestions" section with advice on agent sub-specialization, delegation, and demand signal specification.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GuidePage
    participant ClickableImage
    participant Modal

    User->>GuidePage: Views documentation
    GuidePage->>ClickableImage: Renders image thumbnail
    User->>ClickableImage: Clicks thumbnail
    ClickableImage->>Modal: Opens modal with large image
    User->>Modal: Dismisses modal (click/escape/close)
    Modal->>ClickableImage: Closes modal, restores page state

Loading

Possibly related PRs

• renlabs-dev/torus-docs#11: Added the initial "How-to Guides" section and "Setup a wallet" guide to the sidebar; both PRs evolve the sidebar configuration by introducing new guide entries.

Poem

🐇
New guides to help you stake and grow,
Clickable images now steal the show!
Become a Root Agent—just follow each step,
With modals that open at a gentle tap.
Sidebar expanded, the docs shine bright—
Rabbits rejoice, for learning feels light!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ddb5c4 and be44039.

⛔ Files ignored due to path filters (12)

• public/images/how-to-guide/become-a-root-agent/dao-shape-the-network.png is excluded by !**/*.png
• public/images/how-to-guide/become-a-root-agent/select-the-whitelist-option.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/allocator-app-card-explanation.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/allocator-choose-who-to-allocate-to.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/allocator-confirm-allocation-and-submit.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/allocator-confirm-and-sign-transaction.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/allocator-done-allocated.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/connect-to-wallet.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/fill-in-information.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/open-subwallet-and-sign.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/staked-balance-successfully.png is excluded by !**/*.png
• public/images/how-to-guide/stake-your-torus/wallet-staking-tab.png is excluded by !**/*.png

📒 Files selected for processing (8)

• astro.config.mjs (2 hunks)
• src/components/ClickableImage.astro (1 hunks)
• src/content/docs/agents/demand-signaling.mdx (1 hunks)
• src/content/docs/how-to-guides/become-a-root-agent.mdx (1 hunks)
• src/content/docs/how-to-guides/bridge-to-base.mdx (8 hunks)
• src/content/docs/how-to-guides/register-an-agent.mdx (6 hunks)
• src/content/docs/how-to-guides/setup-a-wallet.mdx (4 hunks)
• src/content/docs/how-to-guides/stake-your-torus.mdx (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.