cli: add smpc guide; guides: add index #393
Conversation
WalkthroughThis PR introduces a new guides documentation section to the site, reorganizes the quick-start guide with improved formatting and explanatory notes, expands CLI command tables with new command entries (download/delete for files; replenish-deposit, cancel, download-result, complete, get-report for orders; list for providers), and standardizes table header styling across command indexes using HTML div elements. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Possibly related PRs
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: 2
🧹 Nitpick comments (1)
docs/cli/commands/files/upload.md (1)
56-56: Consider using a year-agnostic example filename.The change from
data_2025.tar.gztodata_2026.tar.gzappears arbitrary. Documentation examples typically use generic names (e.g.,data_archive.tar.gz) or align with the documentation's date context.
📜 Review details
Configuration used: CodeRabbit 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 (14)
docs/cli/Guides/quick-guide.md(3 hunks)docs/cli/Guides/smpc.md(1 hunks)docs/cli/commands/files/index.md(1 hunks)docs/cli/commands/files/upload.md(3 hunks)docs/cli/commands/index.md(1 hunks)docs/cli/commands/offers/index.md(3 hunks)docs/cli/commands/orders/index.md(1 hunks)docs/cli/commands/providers/index.md(1 hunks)docs/cli/commands/tokens/index.md(1 hunks)docs/cli/commands/workflows/index.md(1 hunks)docs/cli/index.md(2 hunks)docs/guides/index.md(1 hunks)docusaurus.config.js(1 hunks)sidebar.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
docs/**/*.{md,mdx}: Use the existing markdown structure and required frontmatter format for all documentation pages
Follow the established cross-referencing pattern with custom anchor tags in documentation
Maintain consistency with established terminology (e.g., offers, orders, providers, TEE) throughout documentation
Use KaTeX syntax for mathematical formulas in documentation
Respect the hierarchical organization of content within each documentation section
Files:
docs/cli/Guides/smpc.mddocs/cli/Guides/quick-guide.mddocs/cli/commands/index.mddocs/cli/commands/workflows/index.mddocs/cli/commands/tokens/index.mddocs/cli/commands/providers/index.mddocs/guides/index.mddocs/cli/index.mddocs/cli/commands/offers/index.mddocs/cli/commands/files/index.mddocs/cli/commands/orders/index.mddocs/cli/commands/files/upload.md
🧠 Learnings (2)
📚 Learning: 2025-10-09T11:53:27.803Z
Learnt from: CR
Repo: Super-Protocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-10-09T11:53:27.803Z
Learning: Applies to docs/**/*.{md,mdx} : Use KaTeX syntax for mathematical formulas in documentation
Applied to files:
docusaurus.config.js
📚 Learning: 2025-10-09T11:53:27.803Z
Learnt from: CR
Repo: Super-Protocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-10-09T11:53:27.803Z
Learning: Applies to docs/**/*.{md,mdx} : Maintain consistency with established terminology (e.g., offers, orders, providers, TEE) throughout documentation
Applied to files:
docs/cli/commands/offers/index.md
🪛 LanguageTool
docs/cli/Guides/smpc.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- id: "smpc" title: "Secure Multiparty Computation" slug: "/guides/smpc" sidebar_position: 2 ---
(QB_NEW_DE)
🔇 Additional comments (19)
docs/cli/commands/providers/index.md (1)
13-17: Consistent table styling and new command entry look good.The HTML div header styling aligns with the standardized format across other CLI command docs, and the new
providers listcommand follows the established link and description pattern.docs/cli/index.md (1)
97-97: Formatting adjustments maintain consistency.The table formatting changes are consistent with the document structure and properly preserve all configuration keys and descriptions.
Also applies to: 126-130
docs/cli/commands/tokens/index.md (1)
14-14: Header styling update aligns with standardized format.The table header now matches the consistent HTML div styling applied across other CLI command documentation.
docs/cli/commands/workflows/index.md (1)
13-13: Header styling consistent with other command indexes.The table header styling matches the standardized format applied across CLI command documentation.
docs/cli/commands/index.md (1)
12-19: Command groups table properly formatted and comprehensive.The HTML div header styling is correctly applied, and all six command group entries follow the established format with proper links and descriptions. The cross-reference anchors are preserved as per guidelines.
docs/cli/commands/files/index.md (1)
13-18: New file commands properly integrated with consistent formatting.The header styling matches the standardized format, and the two new commands (
files downloadandfiles delete) are correctly formatted with clear, consistent descriptions and proper link references.docs/cli/commands/orders/index.md (1)
13-21: Orders command table expanded with comprehensive new commands.The header styling is consistent with the standardized format across command docs, and the five new command entries follow the established pattern with proper links and descriptions. All command descriptions are clear and consistent in tone.
Please verify that the documentation pages for these newly added commands exist in the repository (e.g.,
/cli/commands/orders/replenish-deposit.md, etc.), as this PR may depend on their presence for links to resolve correctly.docs/cli/commands/offers/index.md (1)
13-13: LGTM! Consistent table header styling.The HTML div wrappers with fixed widths improve the visual consistency of command tables across the documentation.
Also applies to: 25-25, 36-36
docs/cli/commands/files/upload.md (3)
11-11: LGTM! Improved clarity.The addition of "automatically" makes the storage creation behavior more explicit.
46-46: LGTM! Better user guidance.The enhanced description helps users understand how to manage data uploaded with the
--use-addonflag.
62-63: LGTM! More descriptive example paths.The updated paths (
./dataset/and./dataset.resource.json) are more descriptive and clearer than the previous ones.docs/cli/Guides/quick-guide.md (4)
5-5: LGTM! Appropriate ordering.Moving the Quick Deployment Guide to position 1 makes sense as an introductory guide.
21-26: LGTM! Improved table formatting.Consolidating the multiple input directory rows with line breaks makes the table more compact and easier to read.
27-27: LGTM! Essential clarification.This explicit statement about input/output requirements is crucial for developers implementing solutions.
127-131: LGTM! Important clarification for multiple data inputs.This note provides essential information for users working with multiple data inputs, clearly explaining the directory structure inside the CVM.
sidebar.js (1)
49-49: LGTM! Corrected comment.The updated comment now accurately describes the behavior:
collapsed: falsemeans the category is expanded by default.docs/guides/index.md (2)
1-6: LGTM! Appropriate frontmatter for an index page.The configuration correctly positions this as the root page of the guides section.
8-18: LGTM! Well-structured Marketplace guides section.The table provides clear descriptions and follows the established documentation patterns.
docusaurus.config.js (1)
123-132: LGTM! Consistent plugin configuration.The guides plugin configuration follows the established pattern and includes the necessary math and katex support.
However, verify whether the guides section should be searchable. Line 228 shows the search plugin's
docsRouteBasePatharray does not include "guides":docsRouteBasePath: [/*"developers", */"marketplace", "whitepaper", "fundamentals", "cli"],If users should be able to search the guides content, consider adding "guides" to this array.
| --- | ||
| id: "smpc" | ||
| title: "Secure Multiparty Computation" | ||
| slug: "/guides/smpc" | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
There was a problem hiding this comment.
Guide file appears incomplete—missing guide content.
The frontmatter is correctly formatted per documentation guidelines, but the file contains no guide content after the frontmatter block. Since the PR objective is to "add smpc guide," this file should include an actual guide/explanation of Secure Multiparty Computation. Please add the guide content to fulfill the PR objective.
Would you like me to help you add guide content for Secure Multiparty Computation, or is this intentionally a placeholder to be filled later?
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- id: "smpc" title: "Secure Multiparty Computation" slug: "/guides/smpc" sidebar_position: 2 ---
(QB_NEW_DE)
🤖 Prompt for AI Agents
In docs/cli/Guides/smpc.md lines 1-7 the file only contains frontmatter and is
missing the actual guide content; add a substantive SMPC guide below the
frontmatter covering: a short introduction to Secure Multiparty Computation, key
use-cases and benefits, high-level architecture and participants, basic
workflow/steps (e.g., secret sharing, computation, reconstruction), security
considerations and limitations, and a short example or CLI usage snippet (or
link to example) plus links to further reading; keep tone consistent with the
docs, include headings, brief code/command examples if relevant, and ensure the
file satisfies the PR goal of adding an SMPC guide.
|
|
||
| | <div style={{width:225}}>**Guide**</div> | <div style={{width:540}}>**Description**</div> | | ||
| | :- | :- | | ||
| | [Quick Deployment Guide](/cli/guides/quick-guide) | 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. | No newline at end of file |
There was a problem hiding this comment.
Capitalize the first word of the description.
The description should start with "Instructions" (capital I) for consistency with standard capitalization practices.
Apply this diff:
-| [Quick Deployment Guide](/cli/guides/quick-guide) | 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. |
+| [Quick Deployment Guide](/cli/guides/quick-guide) | 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. |📝 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.
| | [Quick Deployment Guide](/cli/guides/quick-guide) | 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. | | |
| | [Quick Deployment Guide](/cli/guides/quick-guide) | 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. | |
🤖 Prompt for AI Agents
In docs/guides/index.md around line 24, the description text starts with a
lowercase "instructions"; change it to start with a capitalized "Instructions"
so the sentence begins "Instructions on deploying..." to match capitalization
conventions. Edit the Markdown line to replace "instructions" with
"Instructions" and keep the rest of the text unchanged.
Summary by CodeRabbit