cli: add solutions guides #405
Conversation
WalkthroughDocumentation restructure introduces three new solution guides (Text Generation WebUI, Unsloth, vLLM) and reorganizes the ComfyUI guide into a Solutions subsection. Data path references ( Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 1
🧹 Nitpick comments (2)
docs/cli/Guides/collaboration.md (1)
95-101: Minor inconsistency in path formatting between guides.The collaboration guide uses trailing slashes in data location paths (
/sp/inputs/,/sp/output/,/sp/certs/) while quick-guide.md uses paths without trailing slashes (e.g.,/sp/inputs). Suggest standardizing path notation across all guides for consistency.docs/cli/Guides/Solutions/vllm.md (1)
14-14: Use relative cross-reference for SPCTL link for consistency.Line 14 uses a hardcoded URL (
https://docs.develop.superprotocol.com/cli/), but other guides in this PR use relative cross-references like[SPCTL](/cli). Updating this to match the pattern indocs/guides/index.mdwill ensure consistency and maintainability.🔎 Proposed fix
- [SPCTL](https://docs.develop.superprotocol.com/cli/) + [SPCTL](/cli)
📜 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 selected for processing (11)
docs/cli/Guides/Solutions/comfyui.mddocs/cli/Guides/Solutions/tgwui.mddocs/cli/Guides/Solutions/unsloth.mddocs/cli/Guides/Solutions/vllm.mddocs/cli/Guides/collaboration.mddocs/cli/Guides/confidential-fine-tuning.mddocs/cli/Guides/provider-tools.mddocs/cli/Guides/quick-guide.mddocs/cli/index.mddocs/guides/index.mddocs/marketplace/Guides/deploy-model.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/index.mddocs/cli/Guides/Solutions/tgwui.mddocs/cli/Guides/quick-guide.mddocs/cli/Guides/Solutions/vllm.mddocs/marketplace/Guides/deploy-model.mddocs/cli/Guides/Solutions/unsloth.mddocs/cli/Guides/confidential-fine-tuning.mddocs/cli/Guides/Solutions/comfyui.mddocs/cli/Guides/provider-tools.mddocs/guides/index.mddocs/cli/Guides/collaboration.md
🪛 Gitleaks (8.30.0)
docs/cli/Guides/Solutions/vllm.md
[high] 60-60: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 markdownlint-cli2 (0.18.1)
docs/cli/Guides/Solutions/unsloth.md
60-60: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
149-149: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
150-150: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
151-151: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: check-build
🔇 Additional comments (7)
docs/cli/Guides/Solutions/tgwui.md (1)
1-6: File appears to contain only frontmatter with no guide content.This new file has metadata but no body content. Verify whether the actual guide content for Text Generation WebUI is missing, or if it will be added separately.
docs/cli/Guides/Solutions/unsloth.md (1)
14-14: Verify cross-references point to correct documentation URLs.Lines 14 and other cross-references use
https://docs.develop.superprotocol.com/...URLs. Confirm these are the correct canonical documentation URLs for the referenced guides, or update to use relative paths if documentation is self-hosted.docs/cli/Guides/confidential-fine-tuning.md (2)
3-3: Content restructuring aligns with PR objectives.The title change to "Confidential Collaboration" and the generalized narrative appropriately broaden the scope beyond fine-tuning while maintaining technical accuracy. The addition of the auditor scenario note on line 18 provides useful context.
Also applies to: 10-11, 18-18
127-131: Data path references and TEE structure table are clear.The table explicitly documents the
/sp/inputs/and/sp/output/data locations, and the expanded/sp/certsdescription now includes "order certificate, private key, and workloadInfo" for completeness. The formatting is consistent with markdown conventions.docs/guides/index.md (2)
28-35: Solutions subsection well-structured and cross-references are correct.The new Solutions subsection properly organizes the four solution guides with accurate cross-references. All slugs align with the files introduced in this PR, and the description column provides clear guidance on each guide's purpose.
21-26: CLI section expansion is well-organized.The expanded CLI guides table now includes the "Confidential Collaboration" entry (referencing the renamed guide) and the three new companion guides. The width adjustments improve readability.
docs/cli/Guides/Solutions/vllm.md (1)
55-63:and
| 2.4. `Select the model option`: | ||
|
|
||
| - `1) Medgemma 27b (offer 15900)`: Select this option if you need an untuned MedGemma 27B. | ||
| - `2) your model`: Select this option to use another model. Further, when prompted about `Model input`, enter one of the following: | ||
| - a path to the model's resource JSON file, if it was already uploaded with SPCTL | ||
| - model offer ID, if the model exists on the Marketplace | ||
| - a path to the local directory with the model to upload it using SPCTL. | ||
| - `3) no model`: No model will be used. | ||
|
|
||
| 2.5. `Enter path to a .py/.ipynb file OR a directory`: Enter the path to your training script (file or directory). For a directory, select the file to run (entrypoint) when prompted. Note that you cannot reuse resource files in this step; scripts should be uploaded every time. |
There was a problem hiding this comment.
Fix list indentation to match markdown lint standards.
Lines 60-62 have list items indented with 4 spaces instead of the expected 2 spaces. This triggers MD007 linting errors. The same issue appears at lines 149-151. Update indentation to use 2 spaces for nested list items.
🔎 Proposed fix for list indentation at lines 56-65
2.4. `Select the model option`:
- - `1) Medgemma 27b (offer 15900)`: Select this option if you need an untuned MedGemma 27B.
- - `2) your model`: Select this option to use another model. Further, when prompted about `Model input`, enter one of the following:
- - `3) no model`: No model will be used.
+ - `1) Medgemma 27b (offer 15900)`: Select this option if you need an untuned MedGemma 27B.
+ - `2) your model`: Select this option to use another model. Further, when prompted about `Model input`, enter one of the following:
+ - `3) no model`: No model will be used.🔎 Proposed fix for list indentation at lines 145-153
3. `Select the model option`:
- - `1) Medgemma 27b (offer 15900)`: Select this option if you need an untuned MedGemma 27B.
- - `2) your model`: Select this option to use another model. Further, when prompted about `Model input`, enter one of the following:
- - `3) no model`: No model will be used.
+ - `1) Medgemma 27b (offer 15900)`: Select this option if you need an untuned MedGemma 27B.
+ - `2) your model`: Select this option to use another model. Further, when prompted about `Model input`, enter one of the following:
+ - `3) no model`: No model will be used.Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
60-60: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In docs/cli/Guides/Solutions/unsloth.md around lines 56 to 65 (and also fix the
same pattern at lines 145 to 153), the nested list items are indented with 4
spaces which triggers MD007; change those nested list items to use 2 spaces
indentation instead (ensure the bullet markers for the three nested items under
option 2 use 2 spaces, and do the same for the other occurrence), keeping the
parent list indentation unchanged so the nested items align with markdown
linting rules.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.