phase 1 5 docs site

Quickstart is the second page most visitors open. A failed copy-paste here loses developers before they read proxy or auth docs. Must reflect Phase 1 reality: auth probe works, chat may return 501 stub — document honestly.

Milestone D.3.3 — Quickstart (5-minute path)

Status: Planned
Goal: D.3
Phase: 1.5 — Docs Site
Wave: 9
Estimated effort: 0.5 day
ADR required: None

Spec detail: MASTER_BRIEF.md Part D (D.3.3).


Why This Milestone Exists

Quickstart is the second page most visitors open. A failed copy-paste here loses developers before they read proxy or auth docs.

Must reflect Phase 1 reality: auth probe works, chat may return 501 stub — document honestly.

Single-page success path drives first API call through proxy with make dev stack.


Non-Goals

  • Kubernetes production deploy (Deployment section)
  • Full API reference (D.3.4)
  • SDK client libraries

Branch

feat/d3-3-quickstart

PR Title

docs(docs): five-minute quickstart (D.3.3)


Prerequisites

  • D.3.2 merged (Getting Started section)

Deliverables

  • Prereqs bullet list (Go ≥ 1.22, Docker, OpenAI key)
  • Clone & boot CodeTabs: git clone … && make dev
  • First request CodeTabs: curl, node, python chat completion
  • 3-line Steps explaining auth, routing, memory write
  • Next steps links → Concepts, Deployment

See MASTER_BRIEF Part D (D.3.3) for full acceptance detail.


Files Affected

File PathActionNotes
docs/app/content/docs/getting-started/quickstart.mdxModifyFull quickstart content

Testing Requirements

  • verifyQuickstart_CopyPaste: Follow page only on clean machine → working response within 5 min
  • verifyQuickstart_501Honesty: Callout documents chat stub if 501
  • verifyQuickstart_CodeTabs: All three client tabs present and syntactically valid

Acceptance Criteria

  • New visitor can copy-paste from this page only and get a working response within 5 minutes
  • Phase 1 limits (501 chat stub) documented in Callout
  • CodeTabs render curl, node, and python variants

Risks

RiskProbabilityImpactMitigation
make dev breaks on Windows without WSLMediumHighDocument Docker Desktop + WSL prerequisite
Env var names drift from composeMediumHighSync with ENVIRONMENT_VARIABLES.md
OpenAI key placeholder confuses usersLowMediumUse <Kbd> for replaceable token pattern
Edit on GitHub

Last updated on

On this page

0%