Skip to content

[docs] Add API key rotation guide to documentation#97

Merged
justfinethanku merged 3 commits intoNateBJones-Projects:mainfrom
goodatbingo:claude/debug-open-brain-api-4UtWB
Mar 24, 2026
Merged

[docs] Add API key rotation guide to documentation#97
justfinethanku merged 3 commits intoNateBJones-Projects:mainfrom
goodatbingo:claude/debug-open-brain-api-4UtWB

Conversation

@goodatbingo
Copy link
Copy Markdown
Contributor

Contribution Type

  • Repo improvement (docs, CI, templates)

What does this do?

Adds comprehensive documentation about OpenRouter API key rotation, including a new FAQ section explaining where keys are stored, how to update them across all locations (Supabase secrets, local .env files, CI/CD configs), and how to verify the new key works. Also adds cross-references in the getting-started guide and recipe example files to direct users to this documentation.

Why this matters

When users rotate their OpenRouter API key, the old key is immediately revoked but may still be referenced in multiple places (Supabase Edge Function secrets, local .env files, deployment configs). This causes silent failures that are difficult to debug. This documentation provides a clear checklist and verification steps to prevent this common issue.

Changes

  • docs/03-faq.md: New "API Key Rotation" FAQ section with:

    • Explanation of the problem
    • Checklist of all places where the key needs updating
    • Verification command using curl
    • Tip about testing immediately after rotation
  • docs/01-getting-started.md: Added warning note about key rotation with link to FAQ

  • recipes/chatgpt-conversation-import/.env.example: Added comment explaining key rotation and pointing to the FAQ

Checklist

  • I've read CONTRIBUTING.md
  • No credentials, API keys, or secrets are included
  • Documentation is clear and actionable

Test Plan

N/A - Documentation only change. No code execution or testing required.

https://claude.ai/code/session_019TG4HnQamZcESGMhYu5MTc

claude and others added 3 commits March 21, 2026 19:52
When users rotate their OpenRouter API key, the old key is revoked
immediately but the new key needs to be updated in multiple places
(Supabase secrets, local .env files). Added FAQ section, setup guide
note, and .env.example reminder to prevent silent breakage.

https://claude.ai/code/session_019TG4HnQamZcESGMhYu5MTc
The ingest-thought edge function reads OPENROUTER_API_KEY from
Supabase secrets. Added a callout so users know to update it here
when rotating keys, with a link to the full FAQ checklist.

https://claude.ai/code/session_019TG4HnQamZcESGMhYu5MTc
Copy link
Copy Markdown
Collaborator

@justfinethanku justfinethanku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review of PR #97

The Good

This is a valuable documentation contribution that addresses a real pain point. The API key rotation checklist is practical, the verification command is helpful, and the cross-references in multiple files ensure users encounter this guidance where they need it.

The writing is clear, actionable, and matches the repo's direct tone. No credentials, no unsafe SQL, no binary blobs. The PR description is thorough and the test plan correctly notes this is documentation-only.

Issues Found

Critical: PR title format

The title "Add API key rotation guide to documentation" is missing the required [docs] category prefix. Per CONTRIBUTING.md line 198, all PR titles must follow the format [category] Short description.

Required change:

  • Rename the PR title to: [docs] Add API key rotation guide to documentation

Notes

  • This is a repo improvement contribution (falls under docs, CI, templates category per CONTRIBUTING.md)
  • No metadata.json required for docs-only changes (only required for contributions that live in recipes/, schemas/, dashboards/, integrations/, primitives/, or extensions/)
  • All 4 changed files are existing documentation files, not new contribution folders
  • The automated review workflow checks will catch the title format issue

Recommendation

Once the PR title is corrected to include the [docs] prefix, this is ready to merge. The content is solid and fills a clear gap in the documentation.

Verdict: Minor fixes needed — Just the title format correction.

@justfinethanku justfinethanku changed the title Add API key rotation guide to documentation [docs] Add API key rotation guide to documentation Mar 24, 2026
@justfinethanku justfinethanku merged commit 0ba24b5 into NateBJones-Projects:main Mar 24, 2026
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.

3 participants