docs: refresh documentation for the current API and fix formatting#106
Merged
Conversation
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
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.
What
A documentation freshness pass ahead of the 0.5.0 release, plus the formatting fix for two files that were already unformatted on
main.Formatting
tsconfig.build.jsonand.changeset/dts-relative-paths.mdwere unformatted onmain(merged without passing prettier), somain's ownnpm run format:checkwas red. Both are now formatted. The whole repo passesformat:check.Documentation accuracy
Reconciled the docs with everything that landed this cycle: the result convention across the client and provider, the route renames, the OTP and magic-link move to POST, email-only registration, and the type renames.
README.mdSeamlessAuthErrorand theSeamlessAuthResultwrapperPOST, with a note on the CSRF reason and the adapter-version dependencyAGENTS.mdPasskeyLoginResult,PasskeyLoginWithPrfResult,PasskeyRegistrationResult,StepUpVerificationResult,StepUpWithPasskeyPrfResult); replaced with the current ones (PasskeyLoginData,PasskeyRegistrationData,StepUpPrfData,MessageResult,CredentialUpdateResult,OrganizationMembershipResult,OrganizationSwitchResult,SeamlessAuthResult) andSeamlessAuthErrorResponsefor the caller to check was removed, since that is no longer trueCONTRIBUTING.md5137was a transposition of5173, contradicting two other lines in the same guide) and two typos (avaliable,integerate)RELEASES.md@seamless-auth/expressversion, and when a change spans both repos the adapter publishes first. This is the gap that made the OTP and magic-link changes a coordination riskSECURITY.mdandLICENSE.mdwere reviewed and are accurate.No changeset
Docs and build-config formatting only. The behaviors these docs describe already shipped with their own changesets, so there is no new adopter-facing change to record. The refreshed README will ship with the next publish as part of the repo state.
Timing note
Merge this before the release PR (#68) is finalized so 0.5.0 publishes with the corrected README. It does not need its own version bump.
Checks
npm run format:checkclean across the repo