docs(readme): refresh Antigravity setup, auth, and CLI usage#310
Open
joycel-github wants to merge 7 commits into
Open
docs(readme): refresh Antigravity setup, auth, and CLI usage#310joycel-github wants to merge 7 commits into
joycel-github wants to merge 7 commits into
Conversation
- Installation: note local Antigravity needs Python 3 + pip; AX starts the Python sidecar and installs pinned SDK deps automatically on first use. - Promote Authentication to a top-level section covering AI Studio and Vertex AI (ADC). - Quick Start / Usage: use the built-in `antigravity` harness consistently, document the `--harness-config` / `--harness-config-json` flags, and add a per-request Antigravity configuration example (incl. the /config command). - Fix the exec example that referenced a nonexistent "coding" harness.
- Move the local Antigravity requirements into a dedicated "Built-in Antigravity harness" section and note it is the default harness. - Simplify Quick Start / Examples to rely on the default harness. - Restore the "run any registered harness" example. - Fold the per-request harness-config examples into the Examples block.
- Note that the Quick Start examples omit --harness and assume an ax.yaml with a default harness; otherwise pass --harness antigravity explicitly. - Reword the built-in harness blurb (Antigravity SDK as a reference harness implementation) and fix `ax exec` formatting.
Drop the callout block and clarify inline that the Quick Start examples rely on the default ax.yaml which runs the built-in Antigravity harness.
- Trim the built-in harness blurb and drop a trailing space. - Clarify the Quick Start example uses the checked-in ax.yaml that sets Antigravity as the default harness. - Fix the "# To keep the same JSON in a file" comment spacing.
0c886f7 to
a18945c
Compare
The prior wording ("requires Python 3 with pip" next to "installs
automatically") read as a contradiction. Make explicit that python3/pip
are the only prerequisite and AX installs the pinned SDK dependencies for
the user on first `ax exec`.
Show `--harness antigravity` explicitly in the "specific harness" example and shorten the per-request harness-config comment.
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
1 participant
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.
--harness-config/--harness-config-json, and add a per-request config example. Fix the example that referenced a nonexistentcodingharness or wrong wordingsStacked on #309. Part of #299