Skip to content

docs: clarify Project ID location and JSON References setting#23

Open
talissoncosta wants to merge 2 commits intomainfrom
docs/clarify-project-id-instructions
Open

docs: clarify Project ID location and JSON References setting#23
talissoncosta wants to merge 2 commits intomainfrom
docs/clarify-project-id-instructions

Conversation

@talissoncosta
Copy link
Contributor

@talissoncosta talissoncosta commented Feb 24, 2026

Summary

Improves the README by referencing the official Flagsmith documentation for credential setup instead of duplicating instructions.

Benefits

  1. Single source of truth - Users get instructions from the official Flagsmith docs
  2. Reduced maintenance - No need to keep two sets of instructions in sync
  3. Always up-to-date - Users automatically see the latest instructions
  4. More detailed - The official docs provide comprehensive step-by-step guidance

Changes

  • Replaced detailed credential instructions with a link to Backstage integration documentation
  • Listed the required credentials (Admin API Key and Project ID) with brief descriptions
  • Simplified the "Getting your Flagsmith credentials" section

🤖 Generated with Claude Code

talissoncosta and others added 2 commits February 24, 2026 10:16
Users need to enable 'Show JSON References' in their account settings
(Developer section) before they can see the JSON data in Project Settings.

Without this setting enabled, users won't be able to see the numeric id
field needed for the project-id annotation.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Instead of duplicating instructions, reference the official Backstage
integration documentation at docs.flagsmith.com. This:

- Provides a single source of truth for credential setup
- Reduces maintenance burden (only one place to update)
- Ensures users get the most up-to-date instructions
- Matches the detailed steps in the official docs

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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