Skip to content

docs(get-started): revamp sidebar and add Send your first trace tutorial#679

Merged
khushalsonawat merged 21 commits into
devfrom
docs/get-started-revamp
Jun 26, 2026
Merged

docs(get-started): revamp sidebar and add Send your first trace tutorial#679
khushalsonawat merged 21 commits into
devfrom
docs/get-started-revamp

Conversation

@khushalsonawat

@khushalsonawat khushalsonawat commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Revamps the Get Started section of the docs and adds its first content page, plus a few global docs-layout improvements made along the way. Product sidebars and all other sections are untouched.

Changes

Get Started sidebar (src/lib/navigation.ts)

  • New structure: Overview, Bring your data in, Migrate, Self-Hosting
  • Removes the old Introduction / Quickstart / Release Notes / fat Self-Hosting entries from this group

Sidebar rendering (src/components/Sidebar.astro)

  • Child nav items now render their badge
  • Items without an href render as muted, non-clickable "Coming soon" rows (LangSmith, Arize)

New tutorial (src/pages/docs/get-started/send-your-first-trace.mdx + screenshot)

  • "Send your first trace" walkthrough using traceAI auto-instrumentation with OpenAI (Python and JS/TS), with an annotated Keys screenshot

Docs layout / UX (DocsLayout.astro, global.css, CodeCopyButtons.astro)

  • Widened the content area (max-w-3xl to max-w-5xl) and removed the 65ch prose cap so text uses the width
  • Capped images at 720px and centered them
  • Widened the "On this page" table of contents
  • Added copy buttons to every code block (plain fences and CodeGroup tabs)

Notes / follow-ups

  • Two placeholder links on the new page ([Auto instrumentation](), [custom spans]()) are intentional TODOs awaiting targets.
  • The framework picker on the trace page is deferred (currently a "browse all integrations" link).

Testing

  • Verified locally with pnpm dev: new sidebar, trace page, copy buttons, widened content, and image sizing all render (HTTP 200).

🤖 Generated with Claude Code

- Restructure the Get Started sidebar (Overview, Bring your data in, Migrate, Self-Hosting)
- Render child badges and disabled "Coming soon" rows in the sidebar
- Add the Send your first trace tutorial: traceAI auto-instrumentation with OpenAI, Python and JS/TS, plus the keys screenshot
- Widen the docs content area, drop the prose width cap, and cap images at 720px
- Widen the "On this page" table of contents
- Add copy buttons to all code blocks
@khushalsonawat khushalsonawat self-assigned this Jun 18, 2026
@khushalsonawat khushalsonawat requested a review from nik13 June 18, 2026 10:39
- Route an OpenAI SDK call through Agent Command Center by changing base_url and api_key (Python and JS/TS)
- Verify via x-agentcc-* response headers and switch providers by model name
- Walk through creating a voice agent definition in Simulate (basics, provider connect with Vapi/Retell Sync, behavior, contact details, save as version v1)
- Note chat agents simulate via the SDK; flag Outbound agents require Assistant ID + API Key
- Image references for the agent-definition list and save-version screenshots (to be added)
…and add screenshots

- Collapse the 6 abstract steps into the 4 actual wizard steps (Open, Basic Info, Configuration, Behaviour)
- Fold contact details into the Configuration step where the UI places them, before Behaviour
- Add four annotated screenshots (welcome, basic info, configuration, behaviour + summary)
- Walk through creating and running a prompt in the Prompt Workbench (open Prompts, start from scratch, name + pick model, write system/user, run, save a version)
- Include a ready-to-use Acme support assistant example
- Image references for the prompts list, create modal, model select, and run-output screenshots (to be added)
…nshots

- Rework into four steps matching the Prompt Workbench flow (open + create, name + write, pick model + tune params, run + save)
- Add five annotated screenshots (create prompt, write prompt, select model, params, run output)
- Replace the homepage with a What is Future AGI explainer: the quality loop, a six-card platform grid, and a featured Build with Falcon banner
- Link the lifecycle terms (prototype, simulate, evaluate, observe, optimize) to their product sections
- Add a server icon to the Card component so the Agent Command Center card renders its icon
@khushalsonawat

Copy link
Copy Markdown
Contributor Author

Superseded by #686, which now targets dev directly and carries the entire Get Started revamp (single merge instead of the stack). Closing to consolidate review there.

Yash Mohan and others added 11 commits June 26, 2026 15:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- match image size/style to the get-started pages
- add the settings-navigation screenshot to step 1
- hide workspace names, use the updated radio-button screenshot
- soften secret/PII masking; trim the description; drop alerts/datadog cards

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- redraw radio buttons as clean rings; use correctly-proportioned screenshot
- point annotation to Organization settings; restore sidebar on sync step
- revert masking to the black masked-block convention

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- route the Organization settings arrow clear of the masked block
- drop redundant masking on the verify screenshot (keys already masked by the UI)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
docs(overview): rewrite the docs landing page (What is Future AGI?)
docs(get-started): add Create your first prompt tutorial
docs(get-started): add Add your first agent definition tutorial
docs(get-started): add Route your first LLM request tutorial
docs(get-started): add Migrate from Langfuse page
commitPirate
commitPirate previously approved these changes Jun 26, 2026
@khushalsonawat khushalsonawat merged commit 2ba5bc6 into dev Jun 26, 2026
3 checks passed
@khushalsonawat khushalsonawat deleted the docs/get-started-revamp branch June 26, 2026 17:50
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