Skip to content

SDK/CLI/API Docs info architecture proposal#76

Draft
guthrie-vast wants to merge 6 commits intomainfrom
willbrennan/sdk-cli-api-docs-ia-proposal
Draft

SDK/CLI/API Docs info architecture proposal#76
guthrie-vast wants to merge 6 commits intomainfrom
willbrennan/sdk-cli-api-docs-ia-proposal

Conversation

@guthrie-vast
Copy link
Collaborator

Summary

  • Add auto-generated CLI command reference (131 pages) and SDK method reference (150+ pages) with sidebar navigation matching API docs category order
  • Add guide pages for Authentication, Permissions, and Templates across CLI and SDK tabs, mirroring the API tab structure
  • Rework SDK quickstart from flat examples into a step-by-step walkthrough
  • Restructure all tabs: top group renamed to "Get Started" with book icon, Authentication/Permissions nested as subpages, command groups ordered by OpenAPI tags with Machines (host-only) last
  • Add redirects for removed legacy pages (cli/get-started, cli/commands)
  • Split API "Permissions and Authorization" into separate Authentication and Permissions pages

Test plan

  • Verify Mintlify preview renders all three tabs correctly
  • Check sidebar hierarchy matches across Documentation, API, CLI, and SDK tabs
  • Confirm redirects work for old URLs
  • Review auto-generated reference pages for accuracy against source repos
  • Review guide page content against API tab counterparts

🤖 Generated with Claude Code

wbrennan899 and others added 6 commits February 23, 2026 15:54
- Fix API key generation link to point to Keys page
- Change search sort to dlperf_per_dphtotal, increase limit to 5
- Add cost estimate, disk size clarification, instance_api_key description
- Add SSH connection step (step 6), reorder clean up to step 7
- Swap destroy/stop order, add onstart callback mention
- Link to Search Offers reference, consolidate Next Steps

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the minimal API introduction with the Hello World guide content,
remove the now-redundant hello-world.mdx, and add a redirect.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Python code tabs alongside curl for all API steps using CodeGroup.
Restore advanced-users-only warning that was on main.
…sh_direct, show instance link

- Expand intro to describe full API scope
- Add scoped API keys tip with link to Create API Key endpoint
- Switch auth step to /users/current/ endpoint
- Add template-based instance creation with link to Templates guide
- Add ssh_direct runtype to create params
- Fix instance_api_key description to include GET access
- Add Show Instance endpoint link in polling section
Add auto-generated CLI command reference (131 pages) and SDK method
reference (150+ pages) with sidebar navigation matching API docs
category order. Add guide pages for Authentication, Permissions, and
Templates across CLI and SDK tabs. Rework SDK quickstart into a
step-by-step walkthrough. Restructure all tabs to use "Get Started"
with book icon, nest Authentication/Permissions as subpages under
an Authentication group. Order command groups to match OpenAPI tags
with Machines (host-only) last. Add redirects for removed pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants