Docs: cover Antigravity, correct stale references, verify every example - #50
Merged
Conversation
Antigravity has been a supported tool since #45 but was absent from the README and most of the doc site. It is now documented everywhere the other three tools are. Corrected claims that did not match the binary: - `oauth_account.json` -> `oauth-account.json` - Backup ids shown as `20260325T114502Z-claude-work`; the real format is `2026-03-25T11-45-02.123Z-0000`, and backups nest as <id>/<tool>/<profile>/ - `jq '.[] | select(.token_warning != null)'` — no such field exists - `jq '... select(.profile == "claude/work") | sort_by(.created_at)'` — backup entries have no `created_at` and `profile` is just the name - `aisw list codex --json | jq '.profiles[].name'` — output is grouped by tool, so this iterated null - Quickstart listed `--from-live` under "Interactive OAuth", which is the opposite of what it does Filled gaps in the reference: missing `--json` on use/remove/rename/ backup restore, missing filter flags on list/status/backup list, missing `--antigravity` on context create/set/unset, and the global flags. Documented previously unwritten behavior: exit codes (0/1/2) and the JSON failure envelope, `~/.aisw/workspaces.json`, `use --all` skip-vs-fail semantics, duplicate-account detection, API-key charset validation, and that `uninstall --remove-data` also purges keyring entries. Site generator: `sync-docs.mjs` hardcodes the SEO descriptions and hero tagline that override doc frontmatter, so those were stale too. Verified: every documented command resolves to a real subcommand, 35 documented workflows execute end to end, and all 16 jq pipelines run clean against real output. Site builds (15 pages), SEO check passes.
burakdede
force-pushed
the
docs/documentation-pass
branch
from
August 1, 2026 22:30
2611831 to
e8601e7
Compare
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.
Documentation-only pass over the README and the doc site. No source changes.
Antigravity was undocumented
It has been a supported tool since #45, but was absent from the README and 11 of 17 doc pages. It is now covered everywhere the other three tools are: support matrix, command reference, contexts, shell hooks, config schema, and workspace guardrails — including its two real constraints:
--api-key,--api-key-stdin, and--from-envare rejected for it.--state-modedoes not apply.Claims that did not match the binary
Each of these was checked against real CLI output rather than read for plausibility:
oauth_account.jsonoauth-account.json20260325T114502Z-claude-work2026-03-25T11-45-02.123Z-0000, nested<id>/<tool>/<profile>/jq 'select(.token_warning != null)'status --jsonjq 'select(.profile == "claude/work") | sort_by(.created_at)'created_at;profileis"work"aisw list codex --json | jq '.profiles[].name'null--from-livelisted under "Interactive OAuth"The three
jqexamples were copy-paste-broken for anyone scripting against them.Reference gaps filled
Missing
--jsononuse/remove/rename/backup restore; missing--tool/--search/--sort/--active-onlyonlist,status, andbackup list; missing--antigravityoncontext create/set/unset; global flags absent from the README entirely.Previously unwritten behavior
0/1/2) and the JSON failure envelope, with a note to branch on the stableerror.kindrather than the message text~/.aisw/workspaces.json— the workspace rules file was not documented at alluse --allskip-vs-fail semanticsuninstall --remove-dataalso purging keyring entriesSite generator
website/scripts/sync-docs.mjshardcodes the SEO descriptions and hero tagline, and those override the doc frontmatter. Fixing the docs alone would have left the site's meta descriptions stale, so the generator was updated too (including adding Antigravity to the keyword list).Verification
jqpipelines run clean against real outputnpm run check:seopassesMerge order
#49 is already merged, so every statement here matches
mainas it stands. No ordering constraint remains.