docs: fix API key provisioning — self-generated, not provided by contact#84
Merged
AaronForinton merged 2 commits intomainfrom Apr 17, 2026
Merged
docs: fix API key provisioning — self-generated, not provided by contact#84AaronForinton merged 2 commits intomainfrom
AaronForinton merged 2 commits intomainfrom
Conversation
Corrected the inaccurate claim that both workspace access and the API key are provided by a PolyAI contact. The API key is self-generated by the user inside Agent Studio. - access-and-waitlist.md: clarify workspace access vs API key source - prerequisites.md: update checklist item wording accordingly - get-started.md: add Step 5 (Generate an API key) with env var export between finding IDs and pulling, renumber Steps 5–6 to 6–7, and replace the misplaced "Next step → Prerequisites" card with "Next step → Installation" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Merged
5 tasks
AaronForinton
added a commit
that referenced
this pull request
Apr 17, 2026
…rphaned docs workflow page (#85) ## Summary Three clean-up fixes to the get-started docs: correct a stale UI label, fill a missing screenshot in the new-user flow, and remove a stranded duplicate page. ## Motivation - The "Data Access" tab was renamed to "API Keys" in Agent Studio — the docs still used the old name. - The get-started new-user flow jumped from "find your IDs" to "poly pull" without showing how to generate an API key, which is required for `poly pull` to work. - `development/docs.md` (nav label: "Docs workflow") was an older, partial version of the AI-agent workflow that `tutorials/build-an-agent.md` covers fully. Keeping it as a lone page under a "Development" section with a mismatched title caused confusion. ## Changes - `prerequisites.md`: "Data Access" tab → "API Keys", button label → "+ API key", image alt text updated - `installation.md`: image alt text updated to match - `get-started.md`: add Step 5 — Generate an API key (with screenshot and `POLY_ADK_KEY` export), renumber old Steps 5–6 to 6–7, fix the bottom "Next step" card to point forward to Installation rather than back to Prerequisites - `development/docs.md`: deleted — content fully covered by Workflow 2 in `tutorials/build-an-agent.md` - `mkdocs.yml`: remove the now-empty Development nav section ## Test strategy - [x] N/A (docs, config, or trivial change) ## Checklist - [x] `ruff check .` and `ruff format --check .` pass - [x] `pytest` passes - [x] No breaking changes to the `poly` CLI interface (or migration path documented) - [x] Commit messages follow [conventional commits](https://www.conventionalcommits.org/) > **Note:** This PR overlaps with #84 on `prerequisites.md` and `get-started.md`. One will need a rebase after the other merges. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.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
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.
Summary
Corrects the inaccurate claim that both workspace access and the API key are provided by a PolyAI contact. The API key is self-generated by the user inside Agent Studio.
Motivation
The docs stated "Both are provided by your PolyAI contact" — this is wrong for the API key. It also meant the Getting Started flow sent users to Prerequisites for an API key after they'd already been told to run
poly pull, which requires the key.Changes
access-and-waitlist.md: distinguish workspace access (from contact) vs API key (self-generated in Agent Studio)prerequisites.md: update checklist item from "obtained from your PolyAI contact" to "generated in Agent Studio"get-started.md: add Step 5 — Generate an API key (withPOLY_ADK_KEYenv var export) between finding account/project IDs and pulling; renumber Steps 5–6 → 6–7; replace the misplaced "Next step → Prerequisites" CTA with "Next step → Installation"Test strategy
poly <command>)Checklist
ruff check .andruff format --check .passpytestpassespolyCLI interface (or migration path documented)