Change the document structure, add Youtube demos

[k3dz0r]

Summary by CodeRabbit

• Documentation
  • Created new guides landing page with embedded video demonstrations
  • Reorganized navigation structure to prioritize guides and demos over CLI content
  • Enhanced existing guides with improved visuals, screenshots, and corrected routing paths
  • Archived CLI documentation for reference

[coderabbitai]

Warning

Rate limit exceeded

@k3dz0r has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 28 minutes and 4 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3cab8173-3f30-4f41-b04b-ce8305df410b

📥 Commits

Reviewing files that changed from the base of the PR and between f4d2e48 and 24e4354.

⛔ Files ignored due to path filters (1)

• docs/guides/images/swarm-ingresses-vllm-openwebui.png is excluded by !**/*.png

📒 Files selected for processing (2)

• docs/guides/index.md
• docs/guides/swarm-vllm-openwebui.md

Walkthrough

Documentation site structure reorganized from CLI-focused (/cli) to guides-focused (/guides) layout, including updated frontmatter slugs, image paths, Docusaurus configuration, navigation items, and home page redirect target.

Changes

Documentation Structure Reorganization

Layer / File(s)	Summary
Guides index page with embedded video content docs/guides/index.md	New guides landing page with Docusaurus frontmatter (id, title, slug, sidebar_position) and multiple titled sections embedding YouTube videos for "Super Swarm in Action" and "Confidential …" demos.
Guide file slug and image path updates docs/guides/swarm-vllm-openwebui.md, docs/guides/swarm-vllm-s3.md, docs/guides/swarm-vllm.md	Updated frontmatter slugs from /guides/... paths to root-level /swarm-vllm-... paths and shifted all image references from ../images/... to ./images/... while adjusting step content placement to align with relocated screenshots. Internal cross-link in swarm-vllm-s3.md updated to point to the new guide anchor path.
Docusaurus configuration and docs plugin restructuring docusaurus.config.js	Updated client-redirects plugin to target /guides, added new archive docs plugin (id archive, ./docs/archive, /archive), commented out the cli docs plugin, and switched the primary classic preset docs source from ./docs/archive to ./docs/guides with route base path /guides. Updated local search docsRouteBasePath from ["cli", "fundamentals"] to ["guides", "fundamentals"].
Navigation bar and sidebar updates docusaurus.config.js, sidebar.js	Added Guides & Demo and Archive navbar items (with appropriate docsPluginId), commented out Super Swarm and CLI navbar entries, and disabled the Whitepaper sidebar category by wrapping it in block comment markers.
Deprecated CLI index page and home redirect docs/cli/index.md, src/pages/index.js	Removed docs/cli/index.md content entirely. Updated Home component useEffect to redirect from /fundamentals to /guides while preserving search and hash parameters.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Super-Protocol/docs#427: Updates the same home-page redirect target and overlapping Docusaurus navigation/search configuration for documentation structure changes.

Poem

🐰✨ The guides now hop to center stage,
From /cli paths to a brighter page—
Videos shimmer, images dance anew,
Navigation blooms in guided hue! 🌱

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately captures the main objectives of the PR: restructuring documentation hierarchy and introducing YouTube video demos.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch youtube

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/guides/index.md`:
- Line 25: The iframe title string "Super Swarm in Action" is incorrect for the
Confidential LLM Deployment section; update the embedded iframe title to match
the section's accessible label (e.g., change the title value from "Super Swarm
in Action" to "Confidential LLM Deployment") so assistive technologies receive
accurate metadata—look for the title="Super Swarm in Action" occurrence in
docs/guides/index.md and replace it with the correct section title.

In `@docs/guides/swarm-vllm-openwebui.md`:
- Around line 96-100: Remove the triple-backtick code fences that are wrapping
the two HTML image tags so the screenshots render as images; specifically locate
the <img src={require('./images/swarm-ingresses-vllm-openwebui.png').default}
.../> and the <img
src={require('./images/swarm-ingresses-vllm-openwebui-verified.png').default}
.../> blocks and delete the opening and closing backticks around each block
while keeping the existing <br/> lines and HTML attributes intact so the
markdown displays the images normally.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: de78c114-7577-4b2e-898d-a86c9e08a437

📥 Commits

Reviewing files that changed from the base of the PR and between 5c0c84a and f4d2e48.

⛔ Files ignored due to path filters (20)

• docs/guides/images/swarm-connect-info.png is excluded by !**/*.png
• docs/guides/images/swarm-create-bucket.png is excluded by !**/*.png
• docs/guides/images/swarm-create-kubernetes-space.png is excluded by !**/*.png
• docs/guides/images/swarm-create-service-account-keys.png is excluded by !**/*.png
• docs/guides/images/swarm-create-service-account-window.png is excluded by !**/*.png
• docs/guides/images/swarm-create-service-account.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses-s3-verified.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses-s3.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses-verified.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses-vllm-verified.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses-vllm.png is excluded by !**/*.png
• docs/guides/images/swarm-ingresses.png is excluded by !**/*.png
• docs/guides/images/swarm-kubernetes-create-cluster.png is excluded by !**/*.png
• docs/guides/images/swarm-kubernetes-download-kubeconfig.png is excluded by !**/*.png
• docs/guides/images/swarm-kubernetes-publish-cluster.png is excluded by !**/*.png
• docs/guides/images/swarm-object-storage-connect-info.png is excluded by !**/*.png
• docs/guides/images/swarm-object-storage-policy-rules.png is excluded by !**/*.png
• docs/guides/images/swarm-object-storage.png is excluded by !**/*.png
• docs/guides/images/swarm-policy-rules-grant-access.png is excluded by !**/*.png
• docs/guides/images/swarm-sign-in.png is excluded by !**/*.png

📒 Files selected for processing (8)

• docs/cli/index.md
• docs/guides/index.md
• docs/guides/swarm-vllm-openwebui.md
• docs/guides/swarm-vllm-s3.md
• docs/guides/swarm-vllm.md
• docusaurus.config.js
• sidebar.js
• src/pages/index.js

💤 Files with no reviewable changes (1)

• docs/cli/index.md