Skip to content

Conversation

@Sipher
Copy link
Collaborator

@Sipher Sipher commented Jul 20, 2025

Summary by CodeRabbit

  • New Features

    • Added a "Start Here" page to the development documentation, providing an organized entry point and resource links for developers.
    • Introduced a "v0.5 Related Topics" section to the explanations documentation for easier navigation of key technical topics.
  • Bug Fixes

    • Corrected minor textual issues and updated apostrophe usage in documentation for consistency.
  • Documentation

    • Reorganized sidebar structure and navigation, including updated section names, reordered items, and improved grouping for easier access.
    • Updated and clarified cautionary notes regarding agent name immutability in agent registration guides.
    • Updated and corrected numerous internal and external documentation links for accuracy and consistency.
    • Removed outdated or redundant documentation files and sections, including deprecated concepts and web app guides.
    • Simplified several documentation pages by removing redundant navigation components and streamlining content.

Sipher and others added 16 commits July 19, 2025 12:26
…ation, and bridging processes for improved user experience
…istration, and root agents for enhanced user understanding and experience
…setting up agent client and server with clear instructions and examples
… specificity and cohesion across documentation
…rus" references for clarity and consistency across guides
…nding of agent systems and related concepts in Torus documentation
… registration, demand signaling, and root agents documentation
…ders, enhancing hierarchy and clarity in Torus guides
…ion page in the start-here section of Torus guides
…s; delete outdated files and improve clarity in navigation
…items for improved clarity and navigation consistency
@coderabbitai
Copy link

coderabbitai bot commented Jul 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update reorganizes the Torus documentation structure and navigation. It restructures sidebar sections, updates and renames documentation slugs, removes outdated or redundant files, and adds new introductory and cautionary content. Numerous internal links were corrected to match the new structure, and several UI card navigation elements were removed from explanation pages.

Changes

File(s) Change Summary
astro.config.mjs Major sidebar reorganization: new sections, updated slugs, reordering, and grouping of items.
src/content/docs/concepts/agents.mdx
src/content/docs/concepts/network-overview.mdx
Removed concept documentation for agents and mainnet concepts.
src/content/docs/development/web-apps-install-and-run(old).mdx
src/content/docs/development/web-apps-overview(old).mdx
Deleted deprecated web app setup and overview guides.
src/content/docs/development/start-here.mdx Added new "Start Here" developer documentation page.
src/content/docs/explanations/start-here.mdx Added "v0.5 Related Topics" section; removed redundant "Torus Mechanics" section.
src/content/docs/explanations/builders/agent-registration.mdx
src/content/docs/how-to-guides/builders/register-an-agent.mdx
Added cautionary notes about the immutability of agent names.
src/content/docs/explanations/v05/capability-permissions.mdx
src/content/docs/explanations/v05/control-space.mdx
src/content/docs/explanations/v05/emission-permissions.mdx
src/content/docs/explanations/v05/permissions.mdx
Removed CardGrid navigation components from explanations.
src/content/docs/explanations/v05/governance-dao.mdx Retitled to "Governance & DAO", updated description, removed navigation and LinkCard.
src/content/docs/explanations/builders/demand-signaling.mdx
src/content/docs/explanations/root-agents/root-agents.mdx
src/content/docs/how-to-guides/participants/bridge-from-base.mdx
src/content/docs/how-to-guides/participants/stake-your-torus.mdx
src/content/docs/how-to-guides/start-here.mdx
Updated internal documentation links to reflect new structure and versioning.
src/content/docs/development/cli/key-management.mdx
src/content/docs/development/cli/balance-operations.mdx
src/content/docs/development/network/global-parameters.mdx
src/content/docs/development/network/running-node.mdx
src/content/docs/development/web/overview-and-setup.mdx
src/content/docs/development/web/querying-data.mdx
src/content/docs/getting-started/tokenomics.mdx
Minor formatting and whitespace corrections.
src/content/docs/web-apps (deprecated)/torus-dao.mdx Removed "Related Topics" CardGrid section.
src/content/docs/web-apps (deprecated)/torus-portal.mdx
src/content/docs/web-apps (deprecated)/torus-wallet.mdx
Updated internal links to new absolute or relocated paths.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Docs Pages

    User->>Sidebar: Navigates documentation
    Sidebar->>Docs Pages: Loads new/updated sections (e.g., "Start Here", "Development")
    Docs Pages-->>User: Presents reorganized content and corrected links
Loading

Possibly related PRs

  • #16: Also reorganizes the sidebar and adds a "Start Here" guide, directly related to documentation navigation changes.
  • #19: Removes the same concept documentation files and updates sidebar configuration, indicating direct overlap in restructuring.
  • #9: Updates sidebar labels, slugs, and groupings, sharing a direct connection in navigation restructuring.

Poem

In the warren of docs, we’ve tidied the halls,
Old tunnels removed, new pathways for all.
“Start Here!” signs posted, so bunnies won’t stray,
With links now aligned, and caution on display.
Hop in, dear friends, the docs are anew—
A burrow well-mapped for explorers like you!
🐇📚✨


📜 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 cf97cc9 and f2d68b0.

📒 Files selected for processing (30)
  • astro.config.mjs (5 hunks)
  • src/content/docs/concepts/agents.mdx (0 hunks)
  • src/content/docs/concepts/network-overview.mdx (0 hunks)
  • src/content/docs/development/cli/balance-operations.mdx (1 hunks)
  • src/content/docs/development/cli/key-management.mdx (2 hunks)
  • src/content/docs/development/network/global-parameters.mdx (1 hunks)
  • src/content/docs/development/network/running-node.mdx (1 hunks)
  • src/content/docs/development/start-here.mdx (1 hunks)
  • src/content/docs/development/web-apps-install-and-run(old).mdx (0 hunks)
  • src/content/docs/development/web-apps-overview(old).mdx (0 hunks)
  • src/content/docs/development/web/overview-and-setup.mdx (1 hunks)
  • src/content/docs/development/web/querying-data.mdx (1 hunks)
  • src/content/docs/explanations/builders/agent-registration.mdx (2 hunks)
  • src/content/docs/explanations/builders/demand-signaling.mdx (1 hunks)
  • src/content/docs/explanations/root-agents/root-agents.mdx (1 hunks)
  • src/content/docs/explanations/start-here.mdx (1 hunks)
  • src/content/docs/explanations/v05/capability-permissions.mdx (0 hunks)
  • src/content/docs/explanations/v05/control-space.mdx (1 hunks)
  • src/content/docs/explanations/v05/emission-permissions.mdx (0 hunks)
  • src/content/docs/explanations/v05/governance-dao.mdx (2 hunks)
  • src/content/docs/explanations/v05/permissions.mdx (1 hunks)
  • src/content/docs/getting-started/tokenomics.mdx (1 hunks)
  • src/content/docs/how-to-guides/builders/register-an-agent.mdx (1 hunks)
  • src/content/docs/how-to-guides/builders/setup-cli.mdx (1 hunks)
  • src/content/docs/how-to-guides/participants/bridge-from-base.mdx (1 hunks)
  • src/content/docs/how-to-guides/participants/stake-your-torus.mdx (1 hunks)
  • src/content/docs/how-to-guides/start-here.mdx (2 hunks)
  • src/content/docs/web-apps (deprecated)/torus-dao.mdx (0 hunks)
  • src/content/docs/web-apps (deprecated)/torus-portal.mdx (1 hunks)
  • src/content/docs/web-apps (deprecated)/torus-wallet.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 b4064f7 into main Jul 20, 2025
3 of 4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jul 24, 2025
Merged
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