Repository navigation
docs: add a Start here section to the root and package READMEs - #197
Merged
Merged
Conversation
Point new readers at the docs quickstarts (Docker self-hosted first, managed second) and the compatibility matrix before the repo-specific setup. The root README also shows the ecosystem topology as a Mermaid diagram with the backend node highlighted, so it is clear where these packages sit between the client SDKs and the auth API. The core, express, fastify, and nextjs package READMEs ship to npm, so they get the short paragraph only, without the diagram, to keep the npm pages short. They pick it up on the next release. 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).
/auth, carrying browser cookies and native bearer tokens to the auth API), and links to "How the pieces connect" and the compatibility matrix.core,express,fastify,nextjs, which ship to npm): a short Start here paragraph with the same links and no diagram.README only, no changeset. The npm pages pick it up on the next release.
Testing
pnpm install --frozen-lockfile && pnpm build && pnpm testpass (core 322, express 195, nextjs 131, fastify 118 tests). The diagram parses and renders with Mermaid 11.Refs fells-code/seamless-auth-docs#45