docs(cli): add docs for agent compact review workflow - #485
Draft
farming-labs-docs[bot] wants to merge 4 commits into
Draft
docs(cli): add docs for agent compact review workflow#485farming-labs-docs[bot] wants to merge 4 commits into
farming-labs-docs[bot] wants to merge 4 commits into
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@farming-labs/astro
@farming-labs/astro-theme
@farming-labs/docs
@farming-labs/farmjs
@farming-labs/theme
@farming-labs/next
@farming-labs/nuxt
@farming-labs/nuxt-theme
@farming-labs/svelte
@farming-labs/svelte-theme
@farming-labs/tanstack-start
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-byand--reason;--review-manifest <path>overrides the manifest location. A newagent.compact.reviewManifestPathconfig option sets a project-relative JSON manifest of reviewed exceptions.docs doctor --agent/docs agent compact --checknow 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 --reviewmode (with--reviewed-by,--reason, and--review-manifest) on the CLI page, add theagent.compact.reviewManifestPathoption (default.farming-labs/agent-compaction-reviews.json) to the Configuration and API ReferenceDocsAgentCompactConfigoption coverage, and note in Token Efficiency that reviewed hash-bound entries preserve intentional modified/hand-authoredagent.mdfiles and must be re-reviewed after source/settings/output drift ordocs doctor --agent/--checkfails.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--checkanddocs doctor --agent. This lets teams preserve intentionalagent.mdedits with a hash-bound review and see failures when those pages drift.--review <page...>(no rewrite/compression; requires explicit pages,--reviewed-by, and--reason) and--review-manifest <path>to override the review manifest location.agent.compact.reviewManifestPath(default.farming-labs/agent-compaction-reviews.json), overridable per run with--review-manifest.docs agent compact --checkanddocs doctor --agentnow report reviewed, invalid-reviewed, and orphaned-review states; they fail on source/settings/output drift until the page is re-reviewed.--reviewto preserve hand-authored or intentionally modifiedagent.md; re-review after any drift; setreviewManifestPathif your project stores the manifest elsewhere.Written for commit 214195a. Summary will update on new commits.