Repository navigation
docs: add a Start here section with the ecosystem diagram - #367
Merged
Merged
Conversation
Point new readers at the docs quickstarts (Docker self-hosted first, managed second) before the repo-specific setup, show where the auth API sits in the ecosystem with a Mermaid topology diagram that highlights this repo, and link the compatibility matrix. The block is shared across the public Seamless Auth repos so the front door reads the same everywhere. Refs fells-code/seamless-auth-docs#45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Part of fells-code/seamless-auth-docs#45 (one front door across the ecosystem). Adds a Start here section after the description, and as the first Contents entry:
seamless-auth-apinode highlighted: it owns sessions and issues the tokens your backend verifiesThe repo's own local and Docker quickstarts are kept, since they cover developing this repo. README only, no changeset.
Testing
npm run format:check,npm run lint,npm run typecheck, andnpm run test:run(1748 passed) pass. The diagram parses and renders with Mermaid 11.Refs fells-code/seamless-auth-docs#45