Repository navigation
docs: add a Start here section to the README - #93
Merged
Merged
Conversation
Add the shared Start here block near the top of the README: links to the self-hosted (Docker) and managed quickstarts, the ecosystem topology diagram, and the compatibility matrix. This package is not a node in the diagram, so the block says where it fits instead: the API, server adapters, React SDKs, admin dashboard, and CLI all validate against these schemas. 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 near the top of the README:
The types package is not a node in the diagram because everything depends on it:
seamless-auth-api,@seamless-auth/coreandnextjs(express and fastify through core), the client, React, and React Native SDKs, the admin dashboard, and the CLI. The README says so in one sentence instead of adding a node with a dozen edges.README only, no changeset (AGENTS.md requires one only for
src/changes).Testing
npm run format:checkandnpm run lintpass.Refs fells-code/seamless-auth-docs#45