-
Notifications
You must be signed in to change notification settings - Fork 0
Update name from wallet stake permission to Wallet permission #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
… it up in Torus Portal to improve documentation clarity
…ce documentation and user understanding in Torus Portal
…ntation for consistency and clarity in user guidance
WalkthroughRenamed “Wallet Stake Permission” to “Wallet Permission” across docs and TOCs, updated related terminology and headings, and added new sidebar items in astro.config.mjs under Explanations → System and How-to Guides → System. The new sidebar entries reuse existing slugs, resulting in duplicate navigation entries. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
🧹 Nitpick comments (9)
src/content/docs/explanations/system/wallet-stake-permission.mdx (2)
3-4: Rename is good; fix lingering “Stake Permission” references for consistency.The page title/description now use “Wallet Permission,” but body/header still say “Stake Permission” (e.g., Line 33 header, Line 28 paragraph). Unify to avoid user confusion and SEO duplication.
Apply:
-### Core Functions of Stake Permission +### Core Functions of Wallet PermissionAnd in the paragraph above:
-... and delegate Stake Permission as exclusive (delegator loses permission) & irrevocable ... +... and delegate Wallet Permission as exclusive (delegator loses permission) & irrevocable ...
44-45: Singularize link text to match target page title.Use “Create Wallet Permission” (singular) for consistency.
-Follow our [step-by-step guide to create wallet permissions](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) for practical implementation instructions. +Follow our [step-by-step guide to create a wallet permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) for practical implementation instructions.src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx (7)
2-4: Use singular “wallet permission” for consistency.Align description with page title.
-title: Create Wallet Permission -description: Step-by-step guide to creating wallet permissions to delegate staking operations while keeping your keys secure. +title: Create Wallet Permission +description: Step-by-step guide to creating a wallet permission to delegate staking operations while keeping your keys secure.
16-18: Tighten intro; singularize and merge sentences.-In this guide, we'll walk through how to create wallet permissions in the Torus Portal. -Wallet permissions enable cold-hot wallet behavior, allowing you to delegate staking operations -to more accessible accounts while keeping your primary keys securely stored offline. +In this guide, we'll create a wallet permission in the Torus Portal. +A wallet permission enables cold‑hot wallet behavior, letting you delegate staking operations +to a more accessible account while keeping your primary keys securely stored offline.
20-24: Keep singular form in “Why” section.You want to maintain high security for your primary wallet while still being able to manage staking operations efficiently. -Wallet permissions let you delegate staking management to hot wallets without exposing your principal funds to transfer risks. +A wallet permission lets you delegate staking management to a hot wallet without exposing your principal funds to transfer risks.
27-28: Match anchor text with section title.-- [Create wallet permission](#create-wallet-permission) +- [Create a wallet permission](#create-wallet-permission)
50-60: Minor copy edits: tab label and preposition.-1. **Visit the [Wallet Permissions Tab in the Torus Portal](https://portal.torus.network/permissions/create-permission/wallet)** - Click the <RedText variant="light">**Wallet Permission**</RedText> tab under Permissions in the Torus Portal. +1. **Visit the [Wallet Permission tab in the Torus Portal](https://portal.torus.network/permissions/create-permission/wallet)** + Click the <RedText variant="light">**Wallet Permission**</RedText> tab under Permissions in the Torus Portal. -2. **Connect your Cold Wallet** - Ensure you're <RedText variant="light">connected with the wallet account</RedText> that holds the stakes you want to delegate management for. +2. **Connect your Cold Wallet** + Ensure you're <RedText variant="light">connected with the wallet account</RedText> that holds the stake you want to delegate management of.Please confirm the portal path is correct: /permissions/create-permission/wallet.
91-98: Success message: add article.-You've successfully created the wallet permission. +You've successfully created a wallet permission.
105-107: Grammar: add article.-Now that you've created wallet permission, you might want to: +Now that you've created a wallet permission, you might want to:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (5)
astro.config.mjs(2 hunks)src/content/docs/explanations/system/wallet-stake-permission.mdx(3 hunks)src/content/docs/explanations/table-of-contents.mdx(1 hunks)src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx(5 hunks)src/content/docs/how-to-guides/table-of-contents.mdx(1 hunks)
| { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" }, | ||
| ], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sidebar duplicate under Explanations → System.
Two items point to the same slug; keep one labeled “Wallet Permission.”
- { label: "Wallet Stake Permission", slug: "explanations/system/wallet-stake-permission" },
+ { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" },
{ label: "Stream Permissions", slug: "explanations/system/stream-permissions" },
{ label: "Capability Permissions", slug: "explanations/system/capability-permissions" },
- { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" },📝 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.
| { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" }, | |
| ], | |
| { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" }, | |
| { label: "Stream Permissions", slug: "explanations/system/stream-permissions" }, | |
| { label: "Capability Permissions", slug: "explanations/system/capability-permissions" }, | |
| ], |
🤖 Prompt for AI Agents
In astro.config.mjs around lines 46-47, the sidebar under Explanations → System
contains a duplicate entry pointing to the same slug
"explanations/system/wallet-stake-permission"; remove the duplicate array/object
entry so only one item remains labeled "Wallet Permission" (ensure the remaining
entry retains the label and slug exactly as "Wallet Permission" /
"explanations/system/wallet-stake-permission").
| { label: "Create Wallet Permission", slug: "how-to-guides/system/create-wallet-stake-permission" }, | ||
| ], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Sidebar duplicate under How‑to Guides → System.
Same slug appears twice. Update the old label and drop the new one.
- { label: "Create Wallet Stake Permission", slug: "how-to-guides/system/create-wallet-stake-permission" },
+ { label: "Create Wallet Permission", slug: "how-to-guides/system/create-wallet-stake-permission" },
{ label: "Manage Permissions", slug: "how-to-guides/system/manage-permissions" },
- { label: "Create Wallet Permission", slug: "how-to-guides/system/create-wallet-stake-permission" },Quick check for mismatched slugs (“stream-permissions” vs “emission-permissions” used elsewhere):
🏁 Script executed:
#!/bin/bash
rg -nP 'explanations/system/(stream-permissions|emission-permissions)'Length of output: 942
Sidebar duplicate under How‑to Guides → System + mismatched explanation slugs
- Update the old label and drop the duplicate so the slug how-to-guides/system/create-wallet-stake-permission appears only once in astro.config.mjs (around lines 95–96).
- Fix TOC mismatch: src/content/docs/explanations/table-of-contents.mdx:29 currently links "Stream Permissions" to /explanations/system/emission-permissions — change it to /explanations/system/stream-permissions to match astro.config.mjs:44 and the how-to pages (src/content/docs/how-to-guides/system/create-stream-permission.mdx:123; src/content/docs/how-to-guides/system/create-emission-permission.mdx:125).
🤖 Prompt for AI Agents
In astro.config.mjs around lines 95–96, remove the duplicate sidebar entry for
the slug how-to-guides/system/create-wallet-stake-permission and update the old
label so that the slug appears only once in the list; then in
src/content/docs/explanations/table-of-contents.mdx around line 29, change the
"Stream Permissions" TOC link from /explanations/system/emission-permissions to
/explanations/system/stream-permissions to match astro.config.mjs and the how‑to
pages.
| - [Wallet Stake Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/) — Secure cold-hot wallet staking delegation | ||
| - [Stream Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled | ||
| - [Capability Permissions](https://docs.torus.network/explanations/system/capability-permissions/) — Fine-grained access control for agent endpoints | ||
| - [Wallet Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/) — Secure cold-hot wallet staking delegation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Duplicate item: consolidate “Wallet Stake Permission” and “Wallet Permission.”
Two entries point to the same slug. Replace the old label and remove the new duplicate.
- - [Wallet Stake Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/) — Secure cold-hot wallet staking delegation
- - [Stream Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled
- - [Capability Permissions](https://docs.torus.network/explanations/system/capability-permissions/) — Fine-grained access control for agent endpoints
- - [Wallet Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/) — Secure cold-hot wallet staking delegation
+ - [Wallet Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/) — Secure cold-hot wallet staking delegation
+ - [Stream Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled
+ - [Capability Permissions](https://docs.torus.network/explanations/system/capability-permissions/) — Fine-grained access control for agent endpointsTo ensure no other duplicates remain:
🏁 Script executed:
#!/bin/bash
rg -nP 'Wallet Stake Permission|Create Wallet Stake Permission|Wallet Permission' -g '!**/node_modules/**'Length of output: 148
🏁 Script executed:
#!/bin/bash
# Robust re-check for duplicate "Wallet Stake Permission"/"Wallet Permission" entries and show TOC snippet if present.
echo "PWD: $(pwd)"
echo
echo "== Locate likely TOC files =="
if command -v fd >/dev/null 2>&1; then
fd -HI -e mdx -g '*table*contents*.mdx' || true
else
echo "fd not installed"
fi
echo
echo "== ripgrep (ignore VCS ignores) =="
if command -v rg >/dev/null 2>&1; then
rg -n --hidden -S --no-ignore-vcs 'Wallet Stake Permission|Wallet Permission' || true
else
echo "rg not installed"
fi
echo
echo "== grep fallback =="
grep -nR --exclude-dir=node_modules -e 'Wallet Stake Permission' -e 'Wallet Permission' . || true
echo
TARGET="src/content/docs/explanations/table-of-contents.mdx"
echo "== Show snippet of $TARGET if exists =="
if [ -f "$TARGET" ]; then
sed -n '1,120p' "$TARGET"
else
echo "$TARGET not found"
fiLength of output: 10283
Remove duplicate "Wallet Stake Permission" entries — keep canonical label "Wallet Permission"
- src/content/docs/explanations/table-of-contents.mdx — delete the "- Wallet Stake Permission" entry (line ~28); keep "- Wallet Permission" (line ~31).
- astro.config.mjs — remove the duplicate objects at lines 43 and 46; keep a single entry labeled "Wallet Permission" with slug "explanations/system/wallet-stake-permission".
- src/content/docs/how-to-guides/table-of-contents.mdx — delete "- Create Wallet Stake Permission" (line ~29); keep "- Create Wallet Permission" (line ~31).
- Verify page titles match the chosen labels: src/content/docs/explanations/system/wallet-stake-permission.mdx (title: "Wallet Permission") and src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx (title: "Create Wallet Permission").
🤖 Prompt for AI Agents
In src/content/docs/explanations/table-of-contents.mdx around line 31, there is
a duplicate entry for the wallet permission pages; remove the "- [Wallet Stake
Permission](https://docs.torus.network/explanations/system/wallet-stake-permission/)"
entry and keep the canonical "- [Wallet Permission](...)" line, then in
astro.config.mjs remove the duplicate objects (keep a single object labeled
"Wallet Permission" with slug "explanations/system/wallet-stake-permission"),
delete the duplicate "- [Create Wallet Stake Permission](...)" entry from
src/content/docs/how-to-guides/table-of-contents.mdx (keep "- [Create Wallet
Permission](...)"), and verify/update the titles in
src/content/docs/explanations/system/wallet-stake-permission.mdx and
src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx so they
read "Wallet Permission" and "Create Wallet Permission" respectively.
| - [Create Stream Permission](https://docs.torus.network/how-to-guides/system/create-stream-permission/) — Share token emission streams with other agents | ||
| - [Create Wallet Stake Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation | ||
| - [Manage Permissions](https://docs.torus.network/how-to-guides/system/manage-permissions/) — View, edit, and revoke existing permission delegations | ||
| - [Create Wallet Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate TOC entry: keep one “Create Wallet Permission.”
Both “Create Wallet Stake Permission” (Line 29) and “Create Wallet Permission” (Line 31) point to the same slug. Remove the old label to avoid duplicate nav.
- - [Create Wallet Stake Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation
- - [Manage Permissions](https://docs.torus.network/how-to-guides/system/manage-permissions/) — View, edit, and revoke existing permission delegations
- - [Create Wallet Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation
+ - [Manage Permissions](https://docs.torus.network/how-to-guides/system/manage-permissions/) — View, edit, and revoke existing permission delegations
+ - [Create Wallet Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation📝 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.
| - [Create Wallet Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation | |
| - [Manage Permissions](https://docs.torus.network/how-to-guides/system/manage-permissions/) — View, edit, and revoke existing permission delegations | |
| - [Create Wallet Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation |
🤖 Prompt for AI Agents
In src/content/docs/how-to-guides/table-of-contents.mdx around line 31, there is
a duplicate TOC entry that links to the same slug as the item on line 29; remove
the line at 31 (the old "[Create Wallet Permission]" entry) so only the intended
"Create Wallet Stake Permission" entry remains, ensuring no duplicate navigation
entries point to the same slug.
Summary by CodeRabbit