Skip to content

Align launch docs, API, and CLI reference with agentsfleet 0.17.0#137

Merged
indykish merged 4 commits into
mainfrom
chore/m123-v2-docs-launch
Jul 12, 2026
Merged

Align launch docs, API, and CLI reference with agentsfleet 0.17.0#137
indykish merged 4 commits into
mainfrom
chore/m123-v2-docs-launch

Conversation

@indykish

@indykish indykish commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites published pages against a new documentation Constitution — one page type per page, required sections, concrete examples with expected output, plain language.
  • Adds a pre-commit documentation linter (scripts/check-documentation.py + tests) enforcing metadata, structure, banned words, acronym expansion, and command-output pairing before commit.
  • Syncs api-reference/error-codes.mdx (verified byte-for-byte against the Zig error-registry generator), the CLI command reference, connector guide, and quickstart against current source truth.
  • Restores github-pr-reviewer as the flagship quickstart/install example — the upstream fleet-bundle repo it depends on is being fixed in a companion PR (Restore root SKILL.md and TRIGGER.md for fleet library onboarding github-pr-reviewer#5).
  • Adds one changelog entry covering the confirmed behavioral fixes landing alongside this docs pass (stale CLI hints, clean --help output, widened GitHub Pull Request webhook acceptance, workspace delete JSON field rename).
  • Net: 27 pages (was 28; billing/plans.mdx merged into billing/budgets.mdx with a redirect), -53.6% words, -54.3% bytes.

Companion product-repo PR (not yet opened) lands the matching source-truth fixes this docs pass depends on.

Test plan

  • make test — 22 documentation-rule tests pass
  • make lint — doc rules, OpenAPI drift, Mintlify validate, broken-links, markdown-link-check all pass
  • gitleaks protect --staged — no leaks found
  • api-reference/error-codes.mdx diffed byte-for-byte against zig build gen-error-codes output — identical

Greptile Summary

This PR aligns the documentation with agentsfleet 0.17.0 and adds automated documentation checks. The main changes are:

  • Rewrites the launch, API, CLI, fleet, billing, memory, and workspace pages.
  • Adds a documentation linter, tests, and a pre-commit hook.
  • Updates the OpenAPI drift check and CLI exit-code guidance.
  • Refreshes error codes, navigation, examples, and the changelog.

Confidence Score: 5/5

This looks safe to merge.

  • Deleted API documentation paths now trigger the OpenAPI drift check.
  • The installation guide no longer assigns every doctor failure to exit code 1.
  • No blocking issue remains in the reviewed fixes.

Important Files Changed

Filename Overview
.githooks/pre-commit Adds pre-commit documentation checks and includes deleted files when deciding whether to run the OpenAPI drift check.
Makefile Adds hook installation and documentation tests, and makes OpenAPI drift failures blocking.
scripts/check-documentation.py Adds automated checks for documentation metadata, structure, language, acronyms, and command output.
scripts/test-documentation.py Adds tests for the documentation rules and pre-commit integration.
cli/install.mdx Updates installation guidance and points doctor failures to the detailed exit-code reference.
cli/agentsfleet.mdx Refreshes the command reference, including the differentiated CLI exit-code contract.
api-reference/error-codes.mdx Replaces the error-code reference with the generated 0.17.0 format and updated response fields.

Reviews (3): Last reviewed commit: "fix: apply the same deletion-filter fix ..." | Re-trigger Greptile

Rewrites published pages to the docs Constitution (concise, testable,
source-verified), adds a pre-commit documentation linter, and syncs
error-code, CLI, connector, and quickstart content against Zig,
OpenAPI, and CLI source truth. Restores github-pr-reviewer as the
quickstart's flagship example now that the upstream fleet-bundle repo
is being fixed in a companion PR.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Comment thread .githooks/pre-commit Outdated
Comment thread cli/install.mdx Outdated
indykish and others added 2 commits July 12, 2026 15:22
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
fe5de57 fixed staged_paths' diff-filter to catch deletions but left
unstaged_paths on the old ACMR filter, so the partial-staging check
above it compares an inconsistent path set. Match both.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@indykish indykish merged commit f82511f into main Jul 12, 2026
5 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