Skip to content

docs: add Quick Start guide to documentation site#205

Merged
spboyer merged 1 commit into
mainfrom
squad/docs-quick-start
Apr 21, 2026
Merged

docs: add Quick Start guide to documentation site#205
spboyer merged 1 commit into
mainfrom
squad/docs-quick-start

Conversation

@spboyer

@spboyer spboyer commented Apr 21, 2026

Copy link
Copy Markdown
Member

Summary

Created a focused 5-minute quick start guide at site/src/content/docs/quick-start.mdx as the first page in the documentation sidebar.

Changes

New file: site/src/content/docs/quick-start.mdx

  • Prerequisites: Go 1.26+ and GitHub Copilot access
  • Installation with 3 options: binary, from source, azd extension (tabbed)
  • Authentication step via copilot login
  • First skill creation workflow
  • Minimal eval.yaml example with one task
  • Run and view results in dashboard
  • Mermaid diagram showing skill → eval → run → results workflow
  • Links to comprehensive guides for next steps

Updated: site/astro.config.mjs

  • Added Quick Start as FIRST sidebar item
  • Maintains existing navigation structure

Updated: site/src/content/docs/index.mdx

  • Enhanced homepage with Quick Start section
  • Added prominent link to new Quick Start guide

Verification

✅ Site builds with npm run build (all 17 pages generated)
✅ quick-start/index.html created successfully
✅ Navigation puts Quick Start first
✅ Distinct from getting-started.mdx (focused vs comprehensive)
✅ All design principles met: single page, runnable commands, workflow diagram, clear next steps

- Create focused 5-minute Quick Start page at site/src/content/docs/quick-start.mdx
- Add installation options (binary, from source, azd extension)
- Include authentication, first skill creation, minimal eval YAML
- Add Mermaid workflow diagram
- Include workflow steps: install → auth → create → write → run → view
- Place Quick Start as first item in sidebar navigation
- Update homepage to prominently link Quick Start guide
- Site builds successfully with 17 pages

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@spboyer spboyer added the documentation Improvements or additions to documentation label Apr 21, 2026
@spboyer spboyer requested a review from wbreza as a code owner April 21, 2026 19:07
@spboyer spboyer added the documentation Improvements or additions to documentation label Apr 21, 2026
@github-actions github-actions Bot enabled auto-merge (squash) April 21, 2026 19:07
@spboyer spboyer merged commit 2c01028 into main Apr 21, 2026
7 of 9 checks passed
@spboyer spboyer deleted the squad/docs-quick-start branch April 21, 2026 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants