docs(readme): add Adopting in another app; neutral examples (#3) #5

Merged
KofTwentyTwo merged 2 commits from docs/GH-3-adopting-in-another-app into develop 2026-10-12 11:20:00 +00:00
KofTwentyTwo commented 2026-10-12 11:09:05 +00:00 (Migrated from github.com)

Closes #3.

  • README gains ## Adopting in another app (stable anchor #adopting-in-another-app), the table proposed in #3, checked against AuthentikQBitConfig, the metadata producers and the permission catalog. Changes from the proposal: the repository is now public and followed by CircleCI, so the Coordinates row says snapshots publish from develop (no RC or release yet), and the Secrets row also names the bootstrapOperators and webhookSecret environment defaults. It links the QQQ adoption checklist (QRun-IO/qqq#1071, section 5).
  • README usage example and src/main Javadoc use neutral names (my-app-admin, my-app-prod) instead of one host's. The kof22 test blueprints and fixtures stay, described as one host's worked example.
  • CHANGELOG Unreleased gains a Documentation entry.

No behavior change. The validation message now reads e.g. my-app-admin, and no test asserts that text.

🤖 Generated with Claude Code

Closes #3. - README gains `## Adopting in another app` (stable anchor `#adopting-in-another-app`), the table proposed in #3, checked against `AuthentikQBitConfig`, the metadata producers and the permission catalog. Changes from the proposal: the repository is now public and followed by CircleCI, so the Coordinates row says snapshots publish from `develop` (no RC or release yet), and the Secrets row also names the `bootstrapOperators` and `webhookSecret` environment defaults. It links the QQQ adoption checklist (QRun-IO/qqq#1071, section 5). - README usage example and `src/main` Javadoc use neutral names (`my-app-admin`, `my-app-prod`) instead of one host's. The kof22 test blueprints and fixtures stay, described as one host's worked example. - CHANGELOG `Unreleased` gains a Documentation entry. No behavior change. The validation message now reads `e.g. my-app-admin`, and no test asserts that text. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Sign in to join this conversation.