Skip to content

docs(readme): onboarding steps for PROVABLY_API_KEY + PROVABLY_ORG_ID#16

Closed
aural-psynapse wants to merge 1 commit into
mainfrom
docs/readme-api-key-onboarding
Closed

docs(readme): onboarding steps for PROVABLY_API_KEY + PROVABLY_ORG_ID#16
aural-psynapse wants to merge 1 commit into
mainfrom
docs/readme-api-key-onboarding

Conversation

@aural-psynapse
Copy link
Copy Markdown
Contributor

What

Adds a short onboarding subsection under ## Configuration walking through how to obtain PROVABLY_API_KEY and PROVABLY_ORG_ID:

  1. Sign up at app.provably.ai.
  2. Create an organisation — the org id is in the post-creation URL.
  3. Left-side menu → Integrations → create one. The generated key is PROVABLY_API_KEY.

Plus a link to provably.ai/docs for full product documentation.

Why

The existing env-var table told readers these values were required but not where to source them — first-time users had no obvious path from pip install to a working config.

…G_ID

New 'Getting PROVABLY_API_KEY and PROVABLY_ORG_ID' subsection under Configuration:

  1. Sign up at app.provably.ai
  2. Create an organisation (org id shown in the URL)
  3. Left-side menu → Integrations → create one (generated key)

Plus a pointer to provably.ai/docs for full product documentation.

Closes the gap surfaced while users were trying to find where these values come
from — the env-var table told them they were required but not where to source them.
@aural-psynapse
Copy link
Copy Markdown
Contributor Author

Bundled into #17 per request.

@aural-psynapse aural-psynapse deleted the docs/readme-api-key-onboarding branch May 6, 2026 13:14
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.

1 participant