Skip to content

docs: MkDocs Material site + minimal README#33

Merged
itaywol merged 2 commits into
mainfrom
docs/mkdocs-site
Jul 1, 2026
Merged

docs: MkDocs Material site + minimal README#33
itaywol merged 2 commits into
mainfrom
docs/mkdocs-site

Conversation

@itaywol

@itaywol itaywol commented Jul 1, 2026

Copy link
Copy Markdown
Owner

What

  • README slimmed 176 → 98 lines: value one-liner, shipped install channels only, 60-second quickstart, core-concepts blurb, link to the docs site.
  • MkDocs Material site under docs/: getting-started, concepts (incl. the library package-manager model + teammate onboarding), guides, full command reference, harness comparison, exchange.
  • .github/workflows/docs.yml: builds mkdocs-material, deploys to GitHub Pages on push to main (path-filtered to docs/**, mkdocs.yml, the workflow) plus manual workflow_dispatch.
  • docs/HARNESS_COMPARISON.md content preserved (moved into the nav'd harness-comparison.md; old path is now a redirect stub).

Notes

  • Every command/flag/path verified against source (internal/cli/commands_*.go, pkg/adept/*.go), not invented.
  • scan.blockSeverity documented with its literal set critical|high|medium (default critical).
  • Pages source already set to GitHub Actions; merging to main publishes to https://itaywol.github.io/adeptability/.

🤖 Generated with Claude Code

itaywol and others added 2 commits July 1, 2026 13:03
Author a full documentation site under docs/ (getting-started, concepts,
guides, command reference, harness comparison, exchange) served via MkDocs
Material, and cut README to a minimal quickstart that links out to it.
Add a GitHub Pages deploy workflow that builds and publishes on push to main.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
checkout v4->v7, setup-python v5->v6, upload-pages-artifact v3->v5,
deploy-pages v4->v5.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@itaywol itaywol merged commit 14c73ea into main Jul 1, 2026
9 checks passed
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