docs: expand contributor and integration guides#71
Merged
Conversation
- CONTRIBUTING.md: add Testing (single-test runs, Postgres e2e, factory example), a 'what a good PR includes' checklist, and a config pointer. - docs/extending.md: message-delivery providers (direct + external), where custom behavior belongs, and what is intentionally not extensible. - docs/api-contract.md: which token comes from where, token shapes/claims, branch-significant status codes, and identifier-vs-email terminology. - Link the new guides from the README docs index and gitignore allowlist. Closes #63 Closes #64 Closes #65
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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.
Closes #63, closes #64, closes #65
Summary
Three documentation gaps from the usability survey, in one PR since they are all docs.
CONTRIBUTING.md (#63)
TEST_DB=postgressplit, and a factory-based test-writing example.docs/configuration.md.docs/extending.md (#64)
directMessaging.ts) and external delivery mode, including the production service-token requirement.schemas,auth).docs/api-contract.md (#65)
204= pending;/refreshreads the refresh token from theAuthorizationheader and rotates it).All request/response/claim details are taken from the route schemas and
token.ts. New docs are linked from the README docs index and added to thedocs/gitignore allowlist.Notes
Docs-only; no code or contract changes, no changeset.