Skip to content

docs(reference): add public API coverage - #56

Merged
aryasaatvik merged 4 commits into
split/react-workshop-themesfrom
split/docs-public-api-reference
Aug 30, 2026
Merged

docs(reference): add public API coverage#56
aryasaatvik merged 4 commits into
split/react-workshop-themesfrom
split/docs-public-api-reference

Conversation

@aryasaatvik

Copy link
Copy Markdown
Member

Summary

  • add generated-style public API reference pages for the core and React packages
  • add an audit that checks exported symbols, API headings, source links, and reference coverage
  • make reference validation part of the docs package workflow
package exports -> reference inventory -> MDX pages -> reference audit

Validation

  • docs build
  • 1,596 reference audits with 0 errors
  • core package build
  • repository lint, format, and diff checks

@github-actions

github-actions Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Tegami

This repository uses Tegami to manage releases. When your changes affect published packages, add a changelog file under .tegami/ before merging.

Create a changelog → · Changelog format

Release preview

Package Bump Version
@domainkit/react minor 0.3.10.4.0
domainkit minor 0.3.10.4.0

This PR does not add changelog files. Pending changelogs from other branches are included in the preview above.

Run bun run tegami locally to create a changelog interactively.

Managed by Tegami.

@greptile-apps

greptile-apps Bot commented Aug 30, 2026

Copy link
Copy Markdown

Greptile Summary

The 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.

  • Adds reference navigation and package/runtime guidance.
  • Adds namespace inventories and usage examples across public entrypoints.
  • Adds missing-and-stale export checks to the docs workflow.

Confidence Score: 4/5

The 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

Important Files Changed

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]
Loading

Fix all with Greploop Fix All in Codex Fix All in Cursor Cloud Agents Fix All in Claude Code Fix All in Cursor

Reviews (7): Last reviewed commit: "fix(docs): scope reference inventory aud..." | Re-trigger Greptile

Comment thread apps/docs/content/reference/promise.mdx Outdated
Comment thread apps/docs/scripts/check-reference.mts Outdated
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from 097ca81 to 5de551b Compare August 30, 2026 22:48
greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from 1a446e3 to ce1d9bc Compare August 30, 2026 22:52
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 22:52

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from 7a138da to c0c098e Compare August 30, 2026 23:00
Comment thread apps/docs/scripts/check-reference.mts Outdated
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from c0c098e to 2658fd8 Compare August 30, 2026 23:03
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from 2658fd8 to 62e10a2 Compare August 30, 2026 23:06
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from 62e10a2 to cc7a9e1 Compare August 30, 2026 23:09
Comment thread apps/docs/scripts/check-reference.mts Outdated
@aryasaatvik
aryasaatvik force-pushed the split/docs-public-api-reference branch from cc7a9e1 to 1aa0f9b Compare August 30, 2026 23:14
Comment thread apps/docs/scripts/check-reference.mts
@aryasaatvik
aryasaatvik merged commit b14e79a into main Aug 30, 2026
3 checks passed
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