Update cli guides structure #408
Conversation
WalkthroughThis PR reorganizes and updates CLI guides documentation by renaming collaboration guides, updating metadata fields (titles and sidebar positions across multiple files), adding a new comprehensive TGWUI deployment guide, and consolidating cross-references to reflect the new guide structure. Order status documentation is also enhanced with a new "Error" status. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/cli/Guides/tgwui.md`:
- Line 232: Fix the grammar in the sentence that currently reads "place a new
main order the same tunnel order" by inserting "with" so it reads "place a new
main order with the same tunnel order and engine configuration but another
compute offer," ensuring the rest of the sentence remains unchanged.
In `@docs/guides/index.md`:
- Line 26: Update the index entry that displays "Confidential Collaboration" for
the link "/cli/guides/multi-party-collab" so the visible title matches the
guide's actual title "Multi-Party Collaboration"; locate the markdown line
containing the link text "Confidential Collaboration" and replace that displayed
text with "Multi-Party Collaboration" to keep the index consistent with the
guide.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (3)
src/.DS_Storeis excluded by!**/.DS_Storesrc/pages/.DS_Storeis excluded by!**/.DS_Storestatic/.DS_Storeis excluded by!**/.DS_Store
📒 Files selected for processing (11)
docs/cli/Guides/Solutions/tgwui.mddocs/cli/Guides/collaboration.mddocs/cli/Guides/comfyui.mddocs/cli/Guides/multi-party-collab.mddocs/cli/Guides/provider-tools.mddocs/cli/Guides/quick-guide.mddocs/cli/Guides/tgwui.mddocs/cli/Guides/unsloth.mddocs/cli/Guides/vllm.mddocs/fundamentals/orders.mddocs/guides/index.md
💤 Files with no reviewable changes (1)
- docs/cli/Guides/Solutions/tgwui.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
docs/**/*.md: Use the existing markdown structure and frontmatter format for documentation
Follow the established cross-referencing pattern with custom anchor tags
Use KaTeX syntax for mathematical formulas where needed
Files:
docs/cli/Guides/quick-guide.mddocs/cli/Guides/provider-tools.mddocs/cli/Guides/tgwui.mddocs/fundamentals/orders.mddocs/guides/index.mddocs/cli/Guides/collaboration.mddocs/cli/Guides/vllm.mddocs/cli/Guides/unsloth.mddocs/cli/Guides/multi-party-collab.mddocs/cli/Guides/comfyui.md
🧠 Learnings (1)
📚 Learning: 2025-12-04T16:15:09.742Z
Learnt from: CR
Repo: Super-Protocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-04T16:15:09.742Z
Learning: Applies to src/theme/**/*.{tsx,ts,jsx,js} : Maintain consistency with existing custom React components (Highlight, Imager, Admonition) in swizzled Docusaurus components
Applied to files:
docs/cli/Guides/comfyui.md
🪛 LanguageTool
docs/cli/Guides/tgwui.md
[style] ~234-~234: Consider using a more formal alternative.
Context: ...commands/orders/download-result) to get more information about the error.
(MORE_INFO)
🔇 Additional comments (19)
docs/cli/Guides/provider-tools.md (1)
3-3: LGTM! Title simplification improves clarity.The simplified title "Provider Tools" is more concise while remaining clear about the guide's purpose.
docs/cli/Guides/quick-guide.md (2)
3-3: LGTM! More action-oriented title.The updated title "Deploy Your App" is more direct and user-focused than "Quick Deployment Guide".
8-8: LGTM! Improved specificity.The clarification that this guide covers deploying "your own solution and data" helps users better understand the scope and purpose.
docs/cli/Guides/collaboration.md (1)
3-3: LGTM! More descriptive title.The updated title "Two-party Collaboration" more accurately describes the Alice and Bob scenario covered in this guide, distinguishing it from multi-party collaboration scenarios.
docs/cli/Guides/comfyui.md (2)
3-3: LGTM! More descriptive title.The updated title "Custom ComfyUI Workflow" clarifies that this guide covers custom workflows with custom nodes, not just general ComfyUI usage.
5-5: Verify sidebar position ordering across all guides.The sidebar_position changed from 2 to 4. Ensure this doesn't conflict with other guides' positions and that the complete ordering is logical.
docs/cli/Guides/unsloth.md (3)
3-3: LGTM! More descriptive title.The updated title "Fine-Tuning With Unsloth" clarifies the guide's purpose and use case, making it easier for users to find relevant content.
5-5: Sidebar position ordering is consistent across all guides.The sidebar_position value of 5 for unsloth.md maintains a logical sequential ordering (1 through 7) across all guide files with no conflicts or gaps.
10-10: Cross-reference update verified.The new path
docs/cli/Guides/multi-party-collab.mdexists and the link in unsloth.md has been correctly updated. No remaining references to the old path as a file reference exist in the documentation.docs/fundamentals/orders.md (1)
78-80: LGTM! Clear status documentation improvements.The distinction between successful completion ("Done") and error completion ("Error") improves clarity and helps users understand order outcomes. This aligns well with the references to the "Error" status in other guides within this PR.
docs/cli/Guides/vllm.md (2)
3-5: LGTM! Clear title and appropriate sidebar repositioning.The updated title "Inference With vLLM" better describes the guide's purpose and maintains consistency with the documentation structure. The sidebar position change aligns with the overall guide reorganization.
8-8: LGTM! Improved sentence flow.Merging the two sentences and inlining the solution anchor improves readability while preserving the custom anchor pattern required by the coding guidelines.
docs/cli/Guides/tgwui.md (5)
1-6: LGTM! Proper frontmatter structure.The frontmatter follows the established format for documentation with appropriate metadata fields (id, title, slug, sidebar_position).
8-11: LGTM! Clear introduction with proper imports.The guide introduction clearly describes the scope and applicability. The Tabs/TabItem imports are correctly placed for the tabbed sections used later in the document.
111-151: LGTM! Well-structured TGWUI configuration example.The JSON configuration is properly formatted with clear instructions for setting
order_idandorder_key. The nested structure for engine settings and tunnel provisioning is logical and complete.
156-174: LGTM! Well-structured ComfyUI configuration example.The JSON configuration mirrors the TGWUI structure appropriately, with ComfyUI-specific engine settings. Consistent with the TGWUI example.
229-234: LGTM! Comprehensive status guidance.The status descriptions provide clear guidance for monitoring deployment, including references to the newly documented "Error" status. The cross-references to the full status list and download-result command are helpful.
docs/cli/Guides/multi-party-collab.md (2)
3-5: LGTM! Clear guide rename and repositioning.The rename from "Confidential Collaboration" to "Multi-Party Collaboration" better describes the guide's focus, and the metadata updates are consistent with the documentation reorganization.
44-48: LGTM! Consistent cross-reference updates.All internal cross-references have been properly updated from
/cli/guides/fine-tuneto/cli/guides/multi-party-collab, maintaining the custom anchor pattern throughout the document. The updates span workflow diagrams, narrative text, and step references.Also applies to: 67-70, 95-101, 141-141
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| The most important statuses (see the [full list](/fundamentals/orders#compute-order)): | ||
|
|
||
| - **Processing**: The compute is executing the order inside a TEE. Your model is either already available or will be available soon. | ||
| - **In Queue**: The order is waiting for the compute to become available. This status appears only if the compute is overloaded with orders. If this status persists for a few minutes, place a new main order the same tunnel order and engine configuration but another compute offer. |
There was a problem hiding this comment.
Minor grammar issue in the sentence.
The phrase "place a new main order the same tunnel order" is missing "with" between "order" and "the same".
📝 Suggested fix
-- **In Queue**: The order is waiting for the compute to become available. This status appears only if the compute is overloaded with orders. If this status persists for a few minutes, place a new main order the same tunnel order and engine configuration but another compute offer.
+- **In Queue**: The order is waiting for the compute to become available. This status appears only if the compute is overloaded with orders. If this status persists for a few minutes, place a new main order with the same tunnel order and engine configuration but another compute offer.🤖 Prompt for AI Agents
In `@docs/cli/Guides/tgwui.md` at line 232, Fix the grammar in the sentence that
currently reads "place a new main order the same tunnel order" by inserting
"with" so it reads "place a new main order with the same tunnel order and engine
configuration but another compute offer," ensuring the rest of the sentence
remains unchanged.
| | [Configure Provider Tools](/cli/guides/provider-tools) | How to set up Provider Tools—a Super Protocol CLI utility for registering <a id="provider"><span className="dashed-underline">providers</span></a> and creating <a id="offer"><span className="dashed-underline">offers</span></a>. | | ||
| | [Quick Deployment Guide](/cli/guides/quick-guide) | Quick instructions on deploying a <a id="solution"><span className="dashed-underline">solution</span></a> and <a id="data"><span className="dashed-underline">data</span></a> on Super Protocol. | | ||
| | [Confidential Collaboration](/cli/guides/fine-tune) | A scenario of confidential collaboration on Super Protocol. | | ||
| | [Confidential Collaboration](/cli/guides/multi-party-collab) | A scenario of confidential collaboration on Super Protocol. | |
There was a problem hiding this comment.
Title mismatch between index and guide.
The link correctly points to /cli/guides/multi-party-collab, but the displayed title "Confidential Collaboration" doesn't match the guide's actual title "Multi-Party Collaboration" (as updated in docs/cli/Guides/multi-party-collab.md line 3). This inconsistency may confuse users navigating from the index.
📝 Suggested fix to align titles
-| [Confidential Collaboration](/cli/guides/multi-party-collab) | A scenario of confidential collaboration on Super Protocol. |
+| [Multi-Party Collaboration](/cli/guides/multi-party-collab) | A scenario of confidential collaboration on Super 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.
| | [Confidential Collaboration](/cli/guides/multi-party-collab) | A scenario of confidential collaboration on Super Protocol. | | |
| | [Multi-Party Collaboration](/cli/guides/multi-party-collab) | A scenario of confidential collaboration on Super Protocol. | |
🤖 Prompt for AI Agents
In `@docs/guides/index.md` at line 26, Update the index entry that displays
"Confidential Collaboration" for the link "/cli/guides/multi-party-collab" so
the visible title matches the guide's actual title "Multi-Party Collaboration";
locate the markdown line containing the link text "Confidential Collaboration"
and replace that displayed text with "Multi-Party Collaboration" to keep the
index consistent with the guide.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.