Skip to content

docs: add release-artifact reference and doctor/config sections#12

Merged
Gsbreddy merged 1 commit into
mainfrom
cursor/documentation-automation-system-dac4
May 2, 2026
Merged

docs: add release-artifact reference and doctor/config sections#12
Gsbreddy merged 1 commit into
mainfrom
cursor/documentation-automation-system-dac4

Conversation

@cursor

@cursor cursor Bot commented May 2, 2026

Copy link
Copy Markdown

Summary

Add docs/release-artifact.md, a new reference document covering the on-disk formats that had no dedicated documentation after the v1.1 rollout. Update docs/operations-and-policy.md with a flightdeck doctor section and a cross-reference to the new doc. Update README.md to link the new page.

Why

After the v1.1 docs push (HTTP API, SDK, operations/policy), three important subsystems still had no reference page:

  • The release.yaml schema (all spec sub-models: routing, safety, tools, prompts, tags) had no field-level docs
  • The workspace config (flightdeck.yaml) was referenced everywhere but never documented
  • Pricing table YAML format, --replace/--reason semantics, and pricing_import_audit were undocumented
  • flightdeck doctor and its three checks had no operational runbook entry

Changes

docs/release-artifact.md (new, 216 lines):

  • release.yaml full field reference with all optional spec sub-models
  • Bundle directory layout and which files are excluded from checksum
  • Bundle checksum algorithm: file collection, sort order, CRLF normalization, hash construction
  • flightdeck.yaml (WorkspaceConfig) field reference with defaults and relationship to policy min_* overrides
  • Pricing table YAML format with all rate fields and cached_input_usd_per_1k_tokens optional field
  • flightdeck pricing import / --replace / --reason semantics and the pricing_import_audit table
  • Pricing accuracy note: cross-release pricing_reference differences and pricing_or_model_changed flag

docs/operations-and-policy.md (updated):

  • Added opening cross-reference to release-artifact.md
  • Added flightdeck doctor section covering the three checks (schema_migrations, promoted_pointer, audit_seq), example output, exit behavior, and audit_seq gap-detection semantics

README.md (updated):

  • Added link to docs/release-artifact.md in the Documentation section

Validation

  • uv sync --frozen --extra dev
  • uv run python -m ruff check src tests
  • uv run python -m pytest
  • uv run python scripts/generate_schemas.py then git diff --exit-code schemas/ (if models/schemas touched)
  • cd web && npm ci && npm run build && cd .. && git diff --exit-code src/flightdeck/server/static/ (if web/src/ or deps changed)
  • uv run flightdeck-quickstart-verify
  • uv run flightdeck --help

This PR is docs-only; no Python source, schemas, or web assets were modified.

Schema / Storage Impact

  • None

Risk

Documentation only. No code changes. All content was verified against the actual source (src/flightdeck/bundle.py, models.py, config.py, doctor.py, storage.py, cli/main.py).

Notes

Covers the knowledge gaps identified by comparing the v1.1 codebase to the docs that shipped with it.

Open in Web View Automation 

Add docs/release-artifact.md covering the subsystems that had no
dedicated documentation after the v1.1 rollout:

- release.yaml full field reference with all optional spec sub-models
  (routing, safety, tools, prompts, tags)
- bundle directory layout and which files are excluded from the checksum
- bundle checksum algorithm: file collection, sort order, text
  normalization (CRLF→LF), and hash construction
- flightdeck.yaml (WorkspaceConfig) field reference with defaults and
  relationship between diff.min_* workspace defaults and policy overrides
- pricing table YAML format with all rate fields and the
  cached_input_usd_per_1k_tokens optional field
- flightdeck pricing import / --replace / --reason semantics and the
  pricing_import_audit table
- pricing accuracy note: cross-release pricing_reference differences
  and how pricing_or_model_changed is surfaced in diffs

Update docs/operations-and-policy.md:
- Add opening cross-reference to release-artifact.md
- Add flightdeck doctor section explaining the three checks
  (schema_migrations, promoted_pointer, audit_seq), output format,
  exit behavior, and audit_seq gap-detection semantics

Update README.md Documentation section to link release-artifact.md.

Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
@Gsbreddy Gsbreddy marked this pull request as ready for review May 2, 2026 09:53
@Gsbreddy Gsbreddy merged commit 7ff9bf6 into main May 2, 2026
2 checks passed
@Gsbreddy Gsbreddy deleted the cursor/documentation-automation-system-dac4 branch May 2, 2026 09:54
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.

2 participants