Skip to content

Conversation

@Sipher
Copy link
Collaborator

@Sipher Sipher commented Jul 19, 2025

Summary by CodeRabbit

  • New Features

    • Added new how-to guides: "Start Here," "Edit your Agent information," and "Setup Torus CLI" for improved onboarding and user support.
  • Documentation

    • Updated multiple guides for clearer instructions, consistent terminology, and improved formatting.
    • Standardized capitalization of "TORUS" and corrected wallet and fee naming throughout documentation.
    • Enhanced agent registration guide with new images and clarified steps.
    • Improved sidebar navigation by consolidating and reorganizing sections for easier access.

Sipher added 4 commits July 18, 2025 20:55
… editing agent info and relevant visuals for a complete user experience
…tive TORUS** as **TORUS** for improved clarity
…size allocation specifics for better user guidance
@coderabbitai
Copy link

coderabbitai bot commented Jul 19, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update reorganizes the documentation sidebar by consolidating and repositioning the "How-to Guides" section, introduces three new how-to guides, and standardizes terminology and formatting across several existing guides. The changes are limited to documentation content and site configuration, with no modifications to code logic or exported entities.

Changes

File(s) Change Summary
astro.config.mjs Reorganized sidebar: moved "Tokenomics" to "Getting Started," consolidated duplicated "How-to Guides" into one section, reordered and cleaned up.
src/content/docs/how-to-guides/start-here.mdx Added new "Start Here" how-to guide for onboarding and navigation.
src/content/docs/how-to-guides/setup-cli.mdx Added new "Setup Torus CLI" how-to guide with installation and usage instructions.
src/content/docs/how-to-guides/edit-your-agent.mdx Added new "Edit your Agent information" how-to guide.
src/content/docs/how-to-guides/bridge-to-base.mdx
src/content/docs/how-to-guides/stake-your-torus.mdx
Standardized "TORUS" capitalization and improved clarity and consistency in instructions.
src/content/docs/how-to-guides/register-an-agent.mdx Improved wording, added image, clarified fee breakdown, and updated step instructions.
src/content/docs/how-to-guides/setup-a-wallet.mdx Fixed typos, improved clarity, and standardized terminology.
src/content/docs/agents/server-setup.mdx
src/content/docs/how-to-guides/become-a-root-agent.mdx
Shortened "Torus Network" to "Torus," standardized wording, and fixed minor typos.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant DocsSidebar
  participant HowToGuides
  participant GuideContent

  User->>DocsSidebar: Opens documentation sidebar
  DocsSidebar->>HowToGuides: Displays consolidated "How-to Guides" section
  User->>HowToGuides: Selects a guide (e.g., "Start Here", "Setup CLI", "Edit your Agent")
  HowToGuides->>GuideContent: Loads selected guide content
  GuideContent-->>User: Presents step-by-step instructions and resources
Loading

Possibly related PRs

  • #14: Adds new how-to guide entries to the sidebar, directly related to the consolidation and reordering in this PR.
  • #11: Introduces the "How-to Guides" section, which this PR further refines and expands.
  • #13: Updates the sidebar by adding new guide entries and correcting capitalization, overlapping with this PR's sidebar reorganization.

Poem

🐇
In the docs, a sidebar anew,
Guides gathered, clear and true.
"Start Here" shines for those unsure,
CLI and Agents—steps demure.
TORUS stands tall, no typo in sight,
Hop along, dear reader, your path is now 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 6c289d2 and 1650157.

⛔ Files ignored due to path filters (3)
  • public/images/how-to-guide/edit-your-agent/allocator-card-edit-agent.png is excluded by !**/*.png
  • public/images/how-to-guide/edit-your-agent/allocator-success-toast.png is excluded by !**/*.png
  • public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png is excluded by !**/*.png
📒 Files selected for processing (10)
  • astro.config.mjs (1 hunks)
  • src/content/docs/agents/server-setup.mdx (2 hunks)
  • src/content/docs/how-to-guides/become-a-root-agent.mdx (4 hunks)
  • src/content/docs/how-to-guides/bridge-to-base.mdx (7 hunks)
  • src/content/docs/how-to-guides/edit-your-agent.mdx (1 hunks)
  • src/content/docs/how-to-guides/register-an-agent.mdx (4 hunks)
  • src/content/docs/how-to-guides/setup-a-wallet.mdx (5 hunks)
  • src/content/docs/how-to-guides/setup-cli.mdx (1 hunks)
  • src/content/docs/how-to-guides/stake-your-torus.mdx (8 hunks)
  • src/content/docs/how-to-guides/start-here.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
🪧 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.

@Sipher Sipher merged commit 04cf364 into main Jul 19, 2025
3 of 4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 13, 2025
Sign up for free to 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