docs: publish generated API reference - #75
Merged
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.
Summary
rescript-tools docoutputsrc/TinyColor.resias the single source of truth for the public APIkind, with no function-name allowlists or denylistsapi.jsonthrough GitHub PagesDependency
This PR is stacked on #74, which defines and documents the public interface.
Merge #74 first, then retarget this PR to
master.Testing
npm run buildnpx --yes node@26 scripts/generate-docs.mtsnpm run checknpm test(220 tests)Deployment note
GitHub Pages is not enabled for this repository yet.
After merging, select Settings → Pages → Build and deployment → GitHub Actions once; subsequent pushes to
masterdeploy automatically.