docs: add a setup-path selector to the getting-started guides#743
Open
rashadism wants to merge 1 commit into
Open
docs: add a setup-path selector to the getting-started guides#743rashadism wants to merge 1 commit into
rashadism wants to merge 1 commit into
Conversation
Replace the collapsible agent callout on "Run Locally on K3d" and "Run in Your Environment" with a two-way selector. Readers choose between an agent-driven install and the manual, step-by-step path, with the agent path shown by default. Both panels are rendered into the page and toggled via the `hidden` attribute rather than mounted on demand, so the full manual guide remains present in the server-rendered HTML and visible to crawlers, and the exported Markdown carries the manual guide alone. - Add the SetupSwitch / SetupAgent / SetupManual components. A deep link or table-of-contents click to a manual heading reveals the manual panel and scrolls to it; while the agent panel is active, the page table of contents is hidden via a data-setup-pane attribute so it does not list the hidden guide. - Extend the markdown-export plugin to drop the interactive agent panel and unwrap the switch containers, keeping the exported Markdown limited to the manual guide. - Install the openchoreo-setup skill at user scope (-g) and refine the surrounding copy and plane-card spacing. Signed-off-by: Rashad Sirajudeen <rashad@wso2.com>
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds a new ChangesSetup switch rollout
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Contributor
Author
|
@coderabbitai review |
Contributor
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@src/components/SetupSwitch/index.tsx`:
- Around line 27-48: The SetupSwitch controls are using tab semantics
incompletely, so either finish the full tabs pattern or simplify them to plain
buttons. In SetupSwitch, if you keep role="tab", add the matching
aria-controls/id wiring, role="tabpanel" on the content areas, and proper roving
tabIndex/keyboard behavior; otherwise remove the tablist/tab roles and leave the
buttons as a simple toggle between agent and manual.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a1c39fbb-fff4-4ac6-852f-3cf840a9edab
📒 Files selected for processing (9)
docs/getting-started/try-it-out/on-k3d-locally.mdxdocs/getting-started/try-it-out/on-your-environment.mdxplugins/docusaurus-plugin-markdown-export/mdxProcessor.jssrc/components/AgentCallout/styles.module.csssrc/components/AgentSetupBuilder/index.tsxsrc/components/AgentSetupBuilder/styles.module.csssrc/components/SetupSwitch/index.tsxsrc/components/SetupSwitch/styles.module.csssrc/css/custom.css
Comment on lines
+27
to
+48
| <div className={styles.band} role="tablist"> | ||
| <button | ||
| type="button" | ||
| className={styles.half} | ||
| role="tab" | ||
| aria-selected={sel === "agent"} | ||
| onClick={() => setSel("agent")} | ||
| > | ||
| <span className={styles.title}>Set this up with your agent</span> | ||
| <span className={styles.desc}>Install the skill and paste one prompt into Claude Code, Codex, Cursor, or any coding agent.</span> | ||
| </button> | ||
| <button | ||
| type="button" | ||
| className={styles.half} | ||
| role="tab" | ||
| aria-selected={sel === "manual"} | ||
| onClick={() => setSel("manual")} | ||
| > | ||
| <span className={styles.title}>Set this up manually</span> | ||
| <span className={styles.desc}>Install each plane yourself, step by step, and learn what every piece does and how it fits together.</span> | ||
| </button> | ||
| </div> |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the relevant file and nearby components.
git ls-files src/components/SetupSwitch/index.tsx src/components/SetupSwitch
echo '--- outline ---'
ast-grep outline src/components/SetupSwitch/index.tsx --view expanded || true
echo '--- file with line numbers (first 220 lines) ---'
cat -n src/components/SetupSwitch/index.tsx | sed -n '1,220p'
echo '--- search for related ARIA/tab patterns in repo ---'
rg -n --hidden --glob '!**/node_modules/**' 'role="tablist"|role="tab"|role="tabpanel"|aria-controls|aria-labelledby' src || trueRepository: openchoreo/openchoreo.github.io
Length of output: 5213
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Read the existing tab implementation used elsewhere for comparison.
cat -n src/pages/ecosystem/item.tsx | sed -n '770,850p'Repository: openchoreo/openchoreo.github.io
Length of output: 4447
Finish the tab semantics or use plain buttons. The controls are marked as tabs, but the panels aren’t wired with aria-controls/id, role="tabpanel", or roving tabIndex, so this reads as an incomplete tabs pattern to assistive tech. Either implement the full contract or drop the tab roles and keep it as a simple toggle.
🤖 Prompt for 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.
In `@src/components/SetupSwitch/index.tsx` around lines 27 - 48, The SetupSwitch
controls are using tab semantics incompletely, so either finish the full tabs
pattern or simplify them to plain buttons. In SetupSwitch, if you keep
role="tab", add the matching aria-controls/id wiring, role="tabpanel" on the
content areas, and proper roving tabIndex/keyboard behavior; otherwise remove
the tablist/tab roles and leave the buttons as a simple toggle between agent and
manual.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Replaces the collapsible "agent" callout at the top of the two install guides
(Run Locally on K3d and Run in Your Environment) with a two-way selector:
Behaviour
hiddenattribute rather than mounting on demand, so the full manual guide stays in the server-rendered HTML and is visible to crawlers.curlof either page returns the complete guide.data-setup-paneattribute) so it does not list the hidden guide..md(andllms.txt) carries the manual guide alone.Notes
nextdocs only; versioned docs are unchanged..mdcontains no agent/prompt content.