Simplify quickstart and UI quickstart onboarding#30
Open
Conversation
Quickstart: - Make the docker compose one-liner the default Steps 1-2 instead of burying it in a Tip box. Collapse the clone-the-repo path into an Accordion for contributors. - Merge agent registration and control creation into a streamlined two-file flow (setup_control.py + my_agent.py) instead of three separate concepts. Remove the redundant double-registration. - Reduce from 4 steps to 3 steps. UI Quickstart: - Lead with "open localhost:8000" since docker compose users already have the UI running. Move manual Node/pnpm setup into an Accordion. - Remove the "Regenerate API Types" section (contributor concern, not onboarding). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Card links check✅ No broken Card links found. Checked external links in 0.4s |
❌ Markdown Lint Issues FoundMarkdownlint found issues in the changed markdown files. Please review and fix them: Files checked:core/quickstart.mdx core/ui-quickstart.mdx To fix locally:
See the markdownlint rules documentation for details on each rule. |
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
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.
Summary
<Accordion>for contributors.setup_control.pycreates the control,my_agent.pyruns the agent). Removes the redundant double-registration and cuts the step count from 4 to 3.<Accordion>for source-runners only.Net result: -184 lines, fewer prerequisites to parse, and a clear copy → paste → run path.
Test plan
quickstart.mdxrenders correctly — Accordion expands/collapses, code blocks copy cleanlyui-quickstart.mdxrenders correctly — Accordion for manual setup works🤖 Generated with Claude Code