{{ message }}
Rewrite README; move deploy and API into docs/#3
Merged
Conversation
- Reorganize around three reader paths: what DelayKit handles, what you can build, and how to deploy. Features list moves above recipes; recipes lead with the agent timeout. - Move long-form deployment content to `docs/deploy.md` (three runtime options, tuning, Postgres migrations). Move the API reference and duration format to `docs/api.md`. README links to both. - Tighten prose throughout. Add a contrast paragraph under the tagline naming what DelayKit isn't.
cgenuity
added a commit
that referenced
this pull request
May 3, 2026
- Add Vocabulary preamble; renumber the remaining 7 invariants (former #3 Identity model becomes the preamble; #4–#8 shift down) - Remove the handler-idempotency invariant — it was end-user authoring guidance, not a property the library maintains, and is already covered by invariant #3 (atomic claim) and the README's Crash recovery paragraph - Move schedule()/debounce()/throttle()/cancel() behavior spec to docs/api.md under a new Behavior section, with a back-pointer for the correctness model - Replace the schema DDL with a one-line link to the migration files; keep the required-indexes paragraph (which is invariant material) - Consolidate "Race conditions and recovery" from six implementation walkthroughs to four invariant-led subsections - Drop the contract-test prescription from #2's "Active-slot acquisition" paragraph — test guidance, not a runtime contract - Standardize "Posthook" capitalization (was "PostHook" in 4 spots) - Update the one cross-reference (`invariant #4` → `invariant #3`) in both the doc and test/race-conditions.test.ts
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.
Top-to-bottom rewrite of the README, reorganized around what DelayKit handles, what you can build, and how to deploy. Long-form deploy content moves to
docs/deploy.md; API reference moves todocs/api.md.