Skip to content

Release the B2B Manage sample and give every sample README the same structure - #13

Open
brionmario wants to merge 2 commits into
thunder-id:mainfrom
brionmario:sample-readmes
Open

brionmario wants to merge 2 commits into
thunder-id:mainfrom
brionmario:sample-readmes

Conversation

@brionmario

Copy link
Copy Markdown
Member

Purpose

Makes the B2B Manage sample releasable, and gives every sample README the same structure.

Approach

Release workflow

  • Adds a sample_b2b_manage input to release.yml, plus its line in the Plan Releases step. The workflow now has 16 of the 25 inputs workflow_dispatch allows.

READMEs

All 14 sample READMEs now follow one pattern:

  1. Banner, then a # title that matches the banner's alt text
  2. A short intro naming the SDK or package, linked
  3. ## Prerequisites, with minimum versions and the ThunderID server
  4. ## Get the sample, with the sample's filtered releases link and npx degit
  5. ## Configure, with the Console template to pick and a table of every variable in the config template
  6. ## Run
  7. Optional sections specific to the sample (How it works, Where things are, Try the API, Redirect-based flow, Back-channel logout)
  8. ## Learn more, linking the docs quickstart guide and the SDK reference
  9. ## License

Along the way:

  • Variable tables now match each sample's .env.example and config templates, including NODE_TLS_REJECT_UNAUTHORIZED and the optional THUNDERID_SCOPE.
  • Console template names match the Console: the browser quickstart now says JavaScript.
  • The minimum Node.js version is now 20 everywhere. Nuxt 4 and Vite 8 need it.
  • Removes the last StackBlitz button, from the Better Auth sample.
  • Doc links point to canonical thunderid.dev pages. I checked them against the live site; the old v1.0.x/sdks/... links only reached a redirect page.

AGENTS.md

  • Documents the README structure.
  • Asks that every new sample be added to release.yml, all three parts, in the same pull request.

Related Issues

Related PRs

Checklist

  • Followed the contribution guidelines.
  • Manual test round performed and verified.
  • Documentation provided. (Add links if there are any)
  • Tests provided. (Add links if there are any)
    • Unit Tests
    • Integration Tests
  • Breaking changes. (Fill if applicable)
    • Breaking changes section filled.
    • breaking change label added.

Security checks

  • Followed secure coding standards.
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.

Signed-off-by: Brion <info@brionmario.com>
Each README now has the same sections in the same order: prerequisites, getting the sample, configuring, running, any sample-specific sections, learn more, and license. AGENTS.md documents that structure and asks for every new sample to be added to the release workflow.

Signed-off-by: Brion <info@brionmario.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