Skip to content

feat(docs): add Starlight documentation site#23

Merged
rhuanbarreto merged 2 commits into
mainfrom
claude/elegant-tharp
Feb 28, 2026
Merged

feat(docs): add Starlight documentation site#23
rhuanbarreto merged 2 commits into
mainfrom
claude/elegant-tharp

Conversation

@rhuanbarreto

Copy link
Copy Markdown
Contributor

Summary

  • Scaffold an Astro/Starlight documentation site in docs/ targeting cli.archgate.dev
  • Write 18 content pages: getting started, core concepts (ADRs, rules, domains), guides (writing ADRs/rules, CI, editor integrations, MCP server, pre-commit hooks), API reference (CLI commands, MCP tools, rule API, ADR schema), and common rule patterns
  • Add deploy-docs.yml GitHub Actions workflow for deploying to GitHub Pages on merge to main
  • Rename existing planning docs from docs/ to plans/

Test plan

  • bun run docs:build succeeds (19 pages built, 18 indexed by Pagefind)
  • bun run validate passes (lint, typecheck, format, 220 tests, 9 ADR checks, build check)
  • Verify GitHub Pages deployment after merge (ensure Pages source is set to GitHub Actions)
  • Confirm cli.archgate.dev resolves to the deployed site

🤖 Generated with Claude Code

rhuanbarreto and others added 2 commits February 28, 2026 04:50
Scaffold an Astro/Starlight documentation site in docs/ with 18 content
pages covering getting started, core concepts, guides, API reference,
and rule pattern examples. Add a GitHub Actions workflow to deploy to
GitHub Pages on merge to main.

- Rename existing planning docs from docs/ to plans/
- Add Astro 5 + Starlight 0.34 project with Bun-based build
- Write comprehensive docs: installation, quick start, ADRs, rules,
  domains, writing guides, CI integration, editor plugins, MCP server,
  pre-commit hooks, CLI commands, MCP tools, rule API, ADR schema,
  and common rule patterns
- Add deploy-docs.yml workflow (GitHub Pages + custom domain)
- Update .gitignore, .prettierignore, .npmignore for docs artifacts
- Add docs:dev, docs:build, docs:preview convenience scripts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add bun, yarn, pnpm install instructions to docs and README
- Add dev dependency install section with npx/bun run usage
- Add GEN-001 Documentation Site ADR codifying docs conventions
- Fix stale path reference in agent memory (docs/ -> plans/)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rhuanbarreto rhuanbarreto merged commit ea949f3 into main Feb 28, 2026
3 checks passed
@archgatebot archgatebot Bot mentioned this pull request Feb 28, 2026
rhuanbarreto added a commit that referenced this pull request Feb 28, 2026
* feat(docs): add Starlight documentation site for cli.archgate.dev

Scaffold an Astro/Starlight documentation site in docs/ with 18 content
pages covering getting started, core concepts, guides, API reference,
and rule pattern examples. Add a GitHub Actions workflow to deploy to
GitHub Pages on merge to main.

- Rename existing planning docs from docs/ to plans/
- Add Astro 5 + Starlight 0.34 project with Bun-based build
- Write comprehensive docs: installation, quick start, ADRs, rules,
  domains, writing guides, CI integration, editor plugins, MCP server,
  pre-commit hooks, CLI commands, MCP tools, rule API, ADR schema,
  and common rule patterns
- Add deploy-docs.yml workflow (GitHub Pages + custom domain)
- Update .gitignore, .prettierignore, .npmignore for docs artifacts
- Add docs:dev, docs:build, docs:preview convenience scripts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add package manager alternatives and GEN-001 ADR

- Add bun, yarn, pnpm install instructions to docs and README
- Add dev dependency install section with npx/bun run usage
- Add GEN-001 Documentation Site ADR codifying docs conventions
- Fix stale path reference in agent memory (docs/ -> plans/)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
rhuanbarreto added a commit that referenced this pull request Mar 3, 2026
* feat(docs): add Starlight documentation site for cli.archgate.dev

Scaffold an Astro/Starlight documentation site in docs/ with 18 content
pages covering getting started, core concepts, guides, API reference,
and rule pattern examples. Add a GitHub Actions workflow to deploy to
GitHub Pages on merge to main.

- Rename existing planning docs from docs/ to plans/
- Add Astro 5 + Starlight 0.34 project with Bun-based build
- Write comprehensive docs: installation, quick start, ADRs, rules,
  domains, writing guides, CI integration, editor plugins, MCP server,
  pre-commit hooks, CLI commands, MCP tools, rule API, ADR schema,
  and common rule patterns
- Add deploy-docs.yml workflow (GitHub Pages + custom domain)
- Update .gitignore, .prettierignore, .npmignore for docs artifacts
- Add docs:dev, docs:build, docs:preview convenience scripts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add package manager alternatives and GEN-001 ADR

- Add bun, yarn, pnpm install instructions to docs and README
- Add dev dependency install section with npx/bun run usage
- Add GEN-001 Documentation Site ADR codifying docs conventions
- Fix stale path reference in agent memory (docs/ -> plans/)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
rhuanbarreto added a commit that referenced this pull request Mar 4, 2026
* feat(docs): add Starlight documentation site for cli.archgate.dev

Scaffold an Astro/Starlight documentation site in docs/ with 18 content
pages covering getting started, core concepts, guides, API reference,
and rule pattern examples. Add a GitHub Actions workflow to deploy to
GitHub Pages on merge to main.

- Rename existing planning docs from docs/ to plans/
- Add Astro 5 + Starlight 0.34 project with Bun-based build
- Write comprehensive docs: installation, quick start, ADRs, rules,
  domains, writing guides, CI integration, editor plugins, MCP server,
  pre-commit hooks, CLI commands, MCP tools, rule API, ADR schema,
  and common rule patterns
- Add deploy-docs.yml workflow (GitHub Pages + custom domain)
- Update .gitignore, .prettierignore, .npmignore for docs artifacts
- Add docs:dev, docs:build, docs:preview convenience scripts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add package manager alternatives and GEN-001 ADR

- Add bun, yarn, pnpm install instructions to docs and README
- Add dev dependency install section with npx/bun run usage
- Add GEN-001 Documentation Site ADR codifying docs conventions
- Fix stale path reference in agent memory (docs/ -> plans/)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This was referenced Mar 4, 2026
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.

1 participant