Skip to content

docs: publish generated API reference - #75

Merged
mikaello merged 8 commits into
masterfrom
docs-github-pages
Sep 13, 2026
Merged

docs: publish generated API reference#75
mikaello merged 8 commits into
masterfrom
docs-github-pages

Conversation

@mikaello

@mikaello mikaello commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • generate a searchable static API reference from ReScript's bundled rescript-tools doc output
  • use the documented src/TinyColor.resi as the single source of truth for the public API
  • infer documentation sections from each extracted item's kind, with no function-name allowlists or denylists
  • run the generator as native TypeScript on Node 26 without a loader or transpiler
  • publish the HTML site and raw api.json through GitHub Pages
  • validate documentation builds on pull requests without deploying them

Dependency

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 build
  • npx --yes node@26 scripts/generate-docs.mts
  • npm run check
  • npm test (220 tests)
  • browser smoke test for layout and API filtering

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 master deploy automatically.

@mikaello
mikaello changed the base branch from master to docs-reassess-rei-issue September 12, 2026 20:29
@mikaello
mikaello deleted the branch master September 12, 2026 20:46
@mikaello mikaello closed this Sep 12, 2026
@mikaello mikaello reopened this Sep 12, 2026
@mikaello
mikaello changed the base branch from docs-reassess-rei-issue to master September 12, 2026 20:49
@mikaello
mikaello merged commit fd51868 into master Sep 13, 2026
3 checks passed
@mikaello
mikaello deleted the docs-github-pages branch September 13, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant