Repository navigation
docs: prepare documentation for public open-source use - #32
Merged
Merged
Conversation
Describe current behavior instead of development history, restructure the deployment guides into steps, add a webhook verification example, a repository layout and a maintainer releasing guide, and fix outdated references and anchors.
Drop expired minimumReleaseAgeExclude entries and the acceptance runner's list of formerly uncommitted files, reword comments that referred to new behavior, and add description, license and repository fields.
✅ Deploy Preview for form-forge-0then0 canceled.
|
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.
Rewrites the documentation for people meeting the project for the first time, and removes development-stage leftovers.
Documentation
<version>.services/deliveries.ts.docs/releasing.mdfor maintainers; packaging and release steps moved out of the installation guide.main(the ruleset requires PRs).Code and config (no behavior change)
docs/api.md.minimumReleaseAgeExcludeentries (all versions are months old; frozen install unchanged).after()new; added package metadata.Checked: relative links and anchors in all Markdown files, format:check, lint, knip, typecheck, unit tests, test:deployment.