docs: add CLI reference and fix doc-code alignment gaps#15
Closed
cursor[bot] wants to merge 1 commit into
Closed
Conversation
- Add docs/cli.md: full CLI reference covering all commands and flags (init, doctor, serve, release register/list/show/verify/diff/promote/ rollback/history, pricing import/show, policy set/show, runs ingest), with exit codes, examples, and an end-to-end workflow walkthrough. - Fix docs/release-artifact.md: schema reference was 'release_artifact.schema.json'; actual file is 'release.schema.json'. - Fix docs/http-api.md: GET /v1/releases example showed checksum as 'sha256:...' but bundle_checksum() returns a raw hex digest with no prefix. - Fix docs/operations-and-policy.md: table count said 'five tables' but the doc listed six; updated to 'six domain tables' and noted the schema_migrations and pricing_import_audit tables maintained by storage. - Fix RELEASE_NOTES.md trust boundary: 'there is no HTTP auth' was inaccurate; FLIGHTDECK_LOCAL_API_TOKEN gates promote/rollback. Updated to accurately describe the two-tier access model (loopback default vs Bearer token when configured). Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
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.
Summary
Triggered by the push of commit
2ab49c5(HTTP 409 docs for policy-blocked promote/rollback). This pass audits existing docs against source code and fills gaps.Docs added
docs/cli.md(new)Full CLI reference covering every command and subcommand:
flightdeck init,doctor,serverelease register/list/show/verify/diff/promote/rollback/historypricing import/showpolicy set/showruns ingestIncludes flag tables, exit codes, example output, and an end-to-end workflow walkthrough. Codepaths covered:
src/flightdeck/cli/main.py(entire file).Docs updated
docs/release-artifact.mdrelease_artifact.schema.json, actual file isrelease.schema.json.docs/http-api.mdGET /v1/releaseschecksum example: was"sha256:..."butbundle_checksum()returns a raw hex digest with nosha256:prefix (verified insrc/flightdeck/bundle.py).docs/operations-and-policy.mdschema_migrationsandpricing_import_audit.RELEASE_NOTES.mdFLIGHTDECK_LOCAL_API_TOKENgatesPOST /v1/promoteandPOST /v1/rollback. Replaced with an accurate two-tier access description (loopback default vs Bearer token when configured).Key knowledge gaps addressed
--helpfor every flag.