Skip to content

docs(cli): add docs for agent compact review workflow - #485

Draft
farming-labs-docs[bot] wants to merge 4 commits into
mainfrom
docs/docs/drift-58df792-fd90qf
Draft

docs(cli): add docs for agent compact review workflow#485
farming-labs-docs[bot] wants to merge 4 commits into
mainfrom
docs/docs/drift-58df792-fd90qf

Conversation

@farming-labs-docs

@farming-labs-docs farming-labs-docs Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Updates documentation after #482 changed behavior that readers may rely on.

What Changed

Adds a review workflow to agent compaction. New CLI flags on docs agent compact: --review <page...> records a hash-bound human review (source, settings, and output hashes) without rewriting or calling the compressor, and requires explicit pages plus --reviewed-by and --reason; --review-manifest <path> overrides the manifest location. A new agent.compact.reviewManifestPath config option sets a project-relative JSON manifest of reviewed exceptions. docs doctor --agent / docs agent compact --check now report and gate on reviewed, invalid-reviewed, and orphaned-review states, failing when a reviewed page's resolved source, settings, or body drifts until it is re-reviewed.

Docs Update

Document the new docs agent compact --review mode (with --reviewed-by, --reason, and --review-manifest) on the CLI page, add the agent.compact.reviewManifestPath option (default .farming-labs/agent-compaction-reviews.json) to the Configuration and API Reference DocsAgentCompactConfig option coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authored agent.md files and must be re-reviewed after source/settings/output drift or docs doctor --agent / --check fails.

Generated by Docs Cloud.


Summary by cubic

Documents the new review workflow for docs agent compact, including flags and config, and clarifies drift gating in --check and docs doctor --agent. This lets teams preserve intentional agent.md edits with a hash-bound review and see failures when those pages drift.

  • CLI: adds --review <page...> (no rewrite/compression; requires explicit pages, --reviewed-by, and --reason) and --review-manifest <path> to override the review manifest location.
  • Config/API: adds agent.compact.reviewManifestPath (default .farming-labs/agent-compaction-reviews.json), overridable per run with --review-manifest.
  • Validation behavior: docs agent compact --check and docs doctor --agent now report reviewed, invalid-reviewed, and orphaned-review states; they fail on source/settings/output drift until the page is re-reviewed.
  • Migration: use --review to preserve hand-authored or intentionally modified agent.md; re-review after any drift; set reviewManifestPath if your project stores the manifest elsewhere.

Written for commit 214195a. Summary will update on new commits.

Review in cubic

Document the new `docs agent compact --review` mode (with `--reviewed-by`, `--reason`, and `--review-manifest`) on the CLI page, add the `agent.compact.reviewManifestPath` option (default `.farming-labs/agent-compaction-reviews.json`) to the Configuration and API Reference `DocsAgentCompactConfig` option coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authored `agent.md` files and must be re-reviewed after source/settings/output drift or `docs doctor --agent` / `--check` fails.
Generated by Docs Cloud via https://docs.farming-labs.dev
Document the new `docs agent compact --review` mode (with `--reviewed-by`, `--reason`, and `--review-manifest`) on the CLI page, add the `agent.compact.reviewManifestPath` option (default `.farming-labs/agent-compaction-reviews.json`) to the Configuration and API Reference `DocsAgentCompactConfig` option coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authored `agent.md` files and must be re-reviewed after source/settings/output drift or `docs doctor --agent` / `--check` fails.
Generated by Docs Cloud via https://docs.farming-labs.dev
Document the new `docs agent compact --review` mode (with `--reviewed-by`, `--reason`, and `--review-manifest`) on the CLI page, add the `agent.compact.reviewManifestPath` option (default `.farming-labs/agent-compaction-reviews.json`) to the Configuration and API Reference `DocsAgentCompactConfig` option coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authored `agent.md` files and must be re-reviewed after source/settings/output drift or `docs doctor --agent` / `--check` fails.
Generated by Docs Cloud via https://docs.farming-labs.dev
Document the new `docs agent compact --review` mode (with `--reviewed-by`, `--reason`, and `--review-manifest`) on the CLI page, add the `agent.compact.reviewManifestPath` option (default `.farming-labs/agent-compaction-reviews.json`) to the Configuration and API Reference `DocsAgentCompactConfig` option coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authored `agent.md` files and must be re-reviewed after source/settings/output drift or `docs doctor --agent` / `--check` fails.
Generated by Docs Cloud via https://docs.farming-labs.dev
@farming-labs-docs farming-labs-docs Bot deleted a comment from vercel Bot Aug 14, 2026
@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Canceled Canceled Aug 14, 2026 7:39pm
farming-labs-docs-docs-cloud Building Building Preview Aug 14, 2026 7:39pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Aug 14, 2026

Copy link
Copy Markdown

Open in StackBlitz

@farming-labs/astro

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro@485

@farming-labs/astro-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro-theme@485

@farming-labs/docs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/docs@485

@farming-labs/farmjs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/farmjs@485

@farming-labs/theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/theme@485

@farming-labs/next

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/next@485

@farming-labs/nuxt

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt@485

@farming-labs/nuxt-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt-theme@485

@farming-labs/svelte

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte@485

@farming-labs/svelte-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte-theme@485

@farming-labs/tanstack-start

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/tanstack-start@485

commit: 214195a

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.

0 participants