docs(reference): add public API coverage - #56
Conversation
TegamiThis repository uses Tegami to manage releases. When your changes affect published packages, add a changelog file under Create a changelog → · Changelog format Release preview
This PR does not add changelog files. Pending changelogs from other branches are included in the preview above. Run Managed by Tegami. |
Greptile SummaryThe PR adds public API reference pages for the core, Promise, testing, transport, React, and provider surfaces, then integrates reference validation into docs audit and build workflows. The validation remains too shallow to guarantee substantive API coverage.
Confidence Score: 4/5The PR should not merge until the reference audit distinguishes substantive API entries from retained inventory names. The docs workflow can report complete reference coverage after an API's descriptive material is removed, because validation checks only whether its backtick-wrapped name remains in the configured table column. Files Needing Attention: apps/docs/scripts/check-reference.mts, apps/docs/content/reference/promise.mdx
|
| Filename | Overview |
|---|---|
| apps/docs/scripts/check-reference.mts | Adds export-to-inventory validation, but name-only extraction still allows substantive API documentation to disappear without failing the build. |
| apps/docs/package.json | Integrates the reference check into both audit and build, propagating the check's incomplete coverage semantics. |
| apps/docs/content/reference/promise.mdx | Adds Promise API guidance and a compact aggregate inventory whose names satisfy the audit without symbol-specific documentation. |
| apps/docs/content/reference/core.mdx | Adds categorized core namespace documentation and lifecycle guidance. |
| apps/docs/content/reference/react.mdx | Adds categorized documentation for the React package's public namespaces. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart LR
A[Package entrypoint exports] --> B[Regex export inventory]
B --> C[MDX inventory names]
C --> D[Missing and stale comparison]
D --> E[Docs audit and build]
Reviews (7): Last reviewed commit: "fix(docs): scope reference inventory aud..." | Re-trigger Greptile
097ca81 to
5de551b
Compare
1a446e3 to
ce1d9bc
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
7a138da to
c0c098e
Compare
c0c098e to
2658fd8
Compare
2658fd8 to
62e10a2
Compare
62e10a2 to
cc7a9e1
Compare
cc7a9e1 to
1aa0f9b
Compare
Summary
Validation