Dev #24
Dev #24
Conversation
… add new sections for emission proposals and root agents
…idance for governance and network economics adjustments
WalkthroughThis update reorganizes documentation navigation and content by moving "Root Agents" materials under the "Goal Leaders" category, updating internal links accordingly, and introducing new documentation pages and guides for "Emission Proposals." Several minor textual and typographical corrections are also included throughout the documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSidebar
participant EmissionProposalGuide
participant GoalLeadersDocs
User->>DocsSidebar: Navigates sidebar
DocsSidebar-->>User: Shows "Goal Leaders" with "Root Agents" and "Emission Proposals"
User->>GoalLeadersDocs: Clicks "Root Agents"
GoalLeadersDocs-->>User: Displays Root Agents documentation
User->>EmissionProposalGuide: Clicks "Emission Proposals"
EmissionProposalGuide-->>User: Displays Emission Proposals explanation/guide
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
src/content/docs/how-to-guides/builders/register-an-agent.mdx (1)
133-134: Duplicate link update – same verification appliesSame slug change as above; once you verify line 34, this anchor will be covered as well.
🧹 Nitpick comments (11)
src/content/docs/getting-started/tokenomics.mdx (1)
13-13: Consider a more descriptive alt text for improved accessibilityNice catch on the typo. However, the alt text is still fairly generic and doesn’t help screen-reader users understand what the graph conveys. A short summary of the graph’s message would be more useful.
-<Image src={graph} alt="Tokenomics Graph" width="1080" /> +<Image src={graph} alt="Graph showing TORUS token emission schedule" width="1080" />src/content/docs/how-to-guides/holders/setup-a-wallet.mdx (1)
50-54: Consider switching to automatic list numbering inside<Steps>Manually maintaining the numeric prefix (
1.,2., …) is error-prone—this PR already had to correct one such mismatch.
With Markdown ordered lists the actual digit is ignored; you can safely use1.for every item and let the renderer handle sequencing:-2. **Activate/Pin the Extension** +1. **Activate/Pin the Extension**This eliminates future renumbering mistakes and keeps diffs smaller.
src/content/docs/explanations/goal-leaders/root-agents.mdx (1)
37-39: Link target looks correct – consider switching to a relative path.The new URL correctly reflects the file-system move to
goal-leaders, so 👍.
For long-term maintainability you may want to drop the absolute host and use a relative path, e.g.-Follow our [step-by-step application guide](https://docs.torus.network/how-to-guides/goal-leaders/become-a-root-agent/) … +Follow our [step-by-step application guide](/how-to-guides/goal-leaders/become-a-root-agent/) …This prevents hard-coding the production domain and avoids future migrations.
src/content/docs/how-to-guides/builders/create-signal.mdx (1)
32-36: Updated prerequisite links are valid.Both links resolve to the new locations; nice catch keeping prerequisites up-to-date.
Consider relative paths for portability, but otherwise LGTM.src/content/docs/getting-started/concepts.mdx (2)
15-16: Minor wording tweakThe sentence is correct but a bit verbose. Consider a lighter construction:
-Torus aligns towards the central point of stake, while stake is decentralized, representing the system as a whole, effectively aligning it to itself. +Torus continually aligns to the decentralized stake root, effectively keeping the system aligned with itself.
22-23: Typo: “granularily” → “granularly”-The permission & delegation system enables agents to granularily specialize while remaining aligned across levels. +The permission & delegation system enables agents to granularly specialize while remaining aligned across levels.src/content/docs/index.mdx (1)
43-45: Reference label likely incorrect – “How it works” doesn’t existThe call-out now says:
skip ahead to How it works
but no page/section with that title exists; the logical destination is still Get stuff done. Suggest reverting the wording or creating a matching heading.
- skip ahead to <RedText variant="light">How it works</RedText> + skip ahead to <RedText variant="light">Get stuff done</RedText>src/content/docs/explanations/goal-leaders/emission-proposals.mdx (1)
56-58: Consider using relative imports for internal linksHard-coding
https://docs.torus.network/...reduces portability for staging environments. Relative paths (/how-to-guides/...) keep links working in branch previews.src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx (3)
50-58: Mismatch with explanation terminologyHere the section is labelled Reward Distribution while the explanation page uses Incentive Distribution. Aligning wording avoids user confusion.
86-88: Grammar tweak: “proposal get denied”Singular subject needs singular verb.
- ≤ 50 % support & > 10 % participation: proposal get denied. + ≤ 50 % support & > 10 % participation: proposal gets denied.
6-12: Unused import:LinkCard
LinkCardis imported but never used in this file. Removing it avoids dead code warnings during build.-import { - Steps, - Aside, - CardGrid, - Card, - LinkCard -} from "@astrojs/starlight/components"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components";
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
astro.config.mjs(2 hunks)src/content/docs/explanations/builders/agent-editing.mdx(1 hunks)src/content/docs/explanations/builders/agent-registration.mdx(1 hunks)src/content/docs/explanations/builders/demand-signaling.mdx(1 hunks)src/content/docs/explanations/goal-leaders/emission-proposals.mdx(1 hunks)src/content/docs/explanations/goal-leaders/root-agents.mdx(1 hunks)src/content/docs/explanations/start-here.mdx(1 hunks)src/content/docs/getting-started/concepts.mdx(1 hunks)src/content/docs/getting-started/tokenomics.mdx(1 hunks)src/content/docs/how-to-guides/builders/create-signal.mdx(1 hunks)src/content/docs/how-to-guides/builders/register-an-agent.mdx(3 hunks)src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx(1 hunks)src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx(1 hunks)src/content/docs/how-to-guides/holders/setup-a-wallet.mdx(2 hunks)src/content/docs/how-to-guides/start-here.mdx(1 hunks)src/content/docs/index.mdx(2 hunks)src/content/docs/web-apps (deprecated)/torus-portal.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/getting-started/concepts.mdx
[grammar] ~21-~21: Ensure spelling is correct
Context: ...n & delegation system enables agents to granularily specialize while remaining aligned acro...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
src/content/docs/explanations/goal-leaders/emission-proposals.mdx
[grammar] ~16-~16: Ensure spelling is correct
Context: ... rate and distribution across different coponents of the protocol. These proposals allow...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (11)
src/content/docs/how-to-guides/holders/setup-a-wallet.mdx (1)
125-127: Attribute typo fixed—LGTM
<RedText variant="light">now uses the correctvariantprop. Component API is respected and no further action is needed.src/content/docs/web-apps (deprecated)/torus-portal.mdx (1)
46-49: URL update looks good.Path now matches the relocated how-to guide. No action needed.
src/content/docs/how-to-guides/start-here.mdx (1)
53-55: Confirm new guides are live before publishingThe two new links rely on freshly-added pages (
become-a-root-agent,create-emission-proposal). If these pages don’t reach production at the same time, users will hit dead links.Run a quick link check or delay merging until the target pages are deployed.
src/content/docs/explanations/builders/agent-registration.mdx (1)
47-48: Link update looks correctURL now matches the new documentation hierarchy. No further action needed.
src/content/docs/getting-started/concepts.mdx (1)
27-28: Good catch on “implementation” typoThe correction is accurate. 👍
src/content/docs/explanations/start-here.mdx (1)
48-49: Navigation update looks consistentLinks match the new goal-leaders structure and the added Emission Proposals doc.
No issues spotted.src/content/docs/how-to-guides/builders/register-an-agent.mdx (2)
34-35: Validate the moved link actually resolvesThe slug was switched from
root-agentstogoal-leaders, but the referenced page was also physically relocated in this PR. Please click-test the built docs (or runastro dev) to ensure the canonical URLhow-to-guides/goal-leaders/become-a-root-agent/renders and isn’t a 404.
119-121: Numbering is now correct – good catch
The previous off-by-one was fixed by renumbering to “7.” which aligns with the six prior steps.src/content/docs/index.mdx (1)
17-18: Link path update looks fineTarget path now matches the new directory structure. 👍
astro.config.mjs (2)
66-68: Sidebar entry added without issuesPaths and nesting are consistent with the new folder hierarchy.
103-105: Good visibility for the new guideAdding Create Emission Proposal here ensures quick access; no further action required.
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Initial agent creation and ownership establishment | ||
| - **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - How agents coordinate through signals | ||
| - **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Special considerations for DAO-approved agents | ||
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)** - Special considerations for DAO-approved agents | ||
|
|
There was a problem hiding this comment.
Broken URL – duplicate goal-leaders segment.
https://docs.torus.network/explanations/goal-leaders/goal-leaders/ will 404.
The page lives at /explanations/goal-leaders/root-agents/.
-**[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)**
+**[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)**Please adjust (and ideally use a leading-slash relative URL).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Initial agent creation and ownership establishment | |
| - **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - How agents coordinate through signals | |
| - **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Special considerations for DAO-approved agents | |
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)** - Special considerations for DAO-approved agents | |
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Initial agent creation and ownership establishment | |
| - **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - How agents coordinate through signals | |
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)** - Special considerations for DAO-approved agents |
🤖 Prompt for AI Agents
In src/content/docs/explanations/builders/agent-editing.mdx around lines 36 to
39, the URL for "Root Agents" contains a duplicated segment causing a 404 error.
Replace the incorrect URL with the correct path
"/explanations/goal-leaders/root-agents/" using a leading slash to make it a
relative URL.
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - How agents become discoverable | ||
| - **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Agents with direct emission access | ||
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)** - Agents with direct emission access | ||
| - **[Agent Server Setup](https://docs.torus.network/explanations/builders/agent-server/)** - Recommended endpoint interface examples |
There was a problem hiding this comment.
Broken link: path points to a non-existent goal-leaders/goal-leaders page
All other files moved the Root Agent docs to goal-leaders/root-agents/, but this bullet links to goal-leaders/goal-leaders/, which 404s.
-**[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)** - Agents with direct emission access
+**[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)** - Agents with direct emission access📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - How agents become discoverable | |
| - **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Agents with direct emission access | |
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/goal-leaders/)** - Agents with direct emission access | |
| - **[Agent Server Setup](https://docs.torus.network/explanations/builders/agent-server/)** - Recommended endpoint interface examples | |
| - **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - How agents become discoverable | |
| - **[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)** - Agents with direct emission access | |
| - **[Agent Server Setup](https://docs.torus.network/explanations/builders/agent-server/)** - Recommended endpoint interface examples |
🤖 Prompt for AI Agents
In src/content/docs/explanations/builders/demand-signaling.mdx around lines 35
to 37, the link for "Root Agents" incorrectly points to a non-existent path
goal-leaders/goal-leaders/. Update this link to the correct path
goal-leaders/root-agents/ to fix the broken link and prevent 404 errors.
| Emission proposals can adapt the token emission rate and distribution across different coponents of the protocol. | ||
|
|
There was a problem hiding this comment.
Spelling error: “coponents” → “components”
Minor typo in the first paragraph.
-Emission proposals can adapt the token emission rate and distribution across different coponents of the protocol.
+Emission proposals can adapt the token emission rate and distribution across different components of the protocol.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Emission proposals can adapt the token emission rate and distribution across different coponents of the protocol. | |
| Emission proposals can adapt the token emission rate and distribution across different components of the protocol. |
🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: Ensure spelling is correct
Context: ... rate and distribution across different coponents of the protocol. These proposals allow...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In src/content/docs/explanations/goal-leaders/emission-proposals.mdx around
lines 16 to 17, fix the spelling error by changing "coponents" to "components"
in the sentence describing emission proposals adapting the token emission rate
and distribution.
| - **Join the community**: Be active in [Discord](https://discord.gg/torus) to share updates about your agent. | ||
| - **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/root-agents/root-agents/) approval criteria and DAO governance | ||
| - **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/goal-leaders/goal-leaders/) approval criteria and DAO governance | ||
| - **Check application status**: Monitor [DAO whitelist applications](https://dao.torus.network/whitelist-applications) for voting progress |
There was a problem hiding this comment.
Incorrect reference to Root Agent explanation page.
Same duplication as above – link should point to /explanations/goal-leaders/root-agents/.
-Learn about [Root Agent](https://docs.torus.network/explanations/goal-leaders/goal-leaders/) approval criteria …
+Learn about [Root Agent](https://docs.torus.network/explanations/goal-leaders/root-agents/) approval criteria …Fix to avoid a broken “What’s Next?” link.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Join the community**: Be active in [Discord](https://discord.gg/torus) to share updates about your agent. | |
| - **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/root-agents/root-agents/) approval criteria and DAO governance | |
| - **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/goal-leaders/goal-leaders/) approval criteria and DAO governance | |
| - **Check application status**: Monitor [DAO whitelist applications](https://dao.torus.network/whitelist-applications) for voting progress | |
| - **Join the community**: Be active in [Discord](https://discord.gg/torus) to share updates about your agent. | |
| - **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/goal-leaders/root-agents/) approval criteria and DAO governance | |
| - **Check application status**: Monitor [DAO whitelist applications](https://dao.torus.network/whitelist-applications) for voting progress |
🤖 Prompt for AI Agents
In src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx around
lines 108 to 110, the link for "Root Agent" explanation incorrectly points to
/explanations/goal-leaders/goal-leaders/. Update this URL to
/explanations/goal-leaders/root-agents/ to fix the broken "What's Next?" link
and ensure it directs to the correct explanation page.
Summary by CodeRabbit
New Features
Documentation