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 introductory guide and resource links for developers.
  • Documentation

    • Reorganized and updated sidebar navigation for improved clarity, grouping related topics and updating slugs.
    • Updated and clarified links throughout the documentation, especially for tokenomics, governance, CLI, and agent-related topics.
    • Added cautionary notes about the permanence of agent names during registration.
    • Improved structure and focus of several explanation and how-to pages, including new sections for Torus v0.5 topics.
    • Removed outdated or redundant documentation pages, including agent concepts, network overview, and deprecated web app guides.
    • Removed or updated related links and card grids for a cleaner reading experience.
    • Made minor textual and formatting corrections across multiple pages.
  • Style

    • Fixed minor typographical errors and formatting inconsistencies in documentation files.

Sipher and others added 15 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
@coderabbitai
Copy link

coderabbitai bot commented Jul 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update reorganizes the documentation structure by modifying sidebar configuration, updating and correcting documentation slugs, and restructuring several documentation sections. It adds a new "Start Here" page for developers, removes outdated or redundant concept and web app overview documents, and updates numerous internal links and cautionary notes for clarity and consistency.

Changes

File(s) Change Summary
astro.config.mjs Sidebar reorganized: slugs updated, sections regrouped, some entries removed or commented, new structure for clarity.
src/content/docs/concepts/agents.mdx
src/content/docs/concepts/network-overview.mdx
src/content/docs/development/web-apps-install-and-run(old).mdx
src/content/docs/development/web-apps-overview(old).mdx
Removed outdated concept and web app overview documentation files.
src/content/docs/development/start-here.mdx Added new "Start Here" page for Torus development docs, with resource links and community support info.
src/content/docs/development/cli/balance-operations.mdx
src/content/docs/development/cli/key-management.mdx
src/content/docs/development/network/global-parameters.mdx
src/content/docs/development/network/running-node.mdx
src/content/docs/development/web/querying-data.mdx
src/content/docs/getting-started/tokenomics.mdx
Minor formatting: newline or whitespace corrections.
src/content/docs/development/web/overview-and-setup.mdx Minor correction: fixed contraction in environment variable note.
src/content/docs/explanations/builders/agent-registration.mdx
src/content/docs/how-to-guides/builders/register-an-agent.mdx
Added cautionary note: agent names are permanent and immutable after registration.
src/content/docs/explanations/builders/demand-signaling.mdx
src/content/docs/explanations/root-agents/root-agents.mdx
src/content/docs/how-to-guides/builders/setup-cli.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 slugs and organization.
src/content/docs/explanations/start-here.mdx Replaced "Torus Mechanics" with new "v0.5 Related Topics" section, updating and consolidating links.
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/LinkCard UI blocks linking to related docs at end of sections.
src/content/docs/explanations/v05/governance-dao.mdx Retitled to "Governance & DAO", updated description, removed navigation links and LinkCard.
src/content/docs/web-apps (deprecated)/torus-dao.mdx Removed "Related Topics" section and card grid.
src/content/docs/web-apps (deprecated)/torus-portal.mdx Updated root agent registration link to absolute path.
src/content/docs/web-apps (deprecated)/torus-wallet.mdx Updated Balance Operations link to new CLI documentation path.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSidebar
    participant DocsPages

    User->>DocsSidebar: Navigates documentation
    DocsSidebar->>DocsPages: Loads page via updated slug/section
    DocsPages-->>User: Displays updated content or structure
Loading

Possibly related PRs

  • #16: Also restructures the sidebar and adds a "Start Here" guide, directly related to navigation and documentation organization.
  • #9: Updates sidebar labels and slugs in the same configuration file, indicating a related scope of sidebar updates.
  • #7: Changes slug prefixes for "v0.5" documentation, closely related to the slug and sidebar restructuring in this PR.

Poem

🐇
A hop, a skip, the docs rearrange,
New paths and guides—how things have changed!
Out with the old, in with the clear,
"Start Here" welcomes all engineers.
Links now point where they should go,
The sidebar’s neat—just so!
Hooray for docs that help us grow!


📜 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 2040bdb and bb34a62.

📒 Files selected for processing (30)
  • astro.config.mjs (3 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 cf97cc9 into main Jul 20, 2025
2 of 4 checks passed
This was referenced Jul 20, 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