Skip to content

Docs interfaces #667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Docs interfaces #667

wants to merge 2 commits into from

Conversation

stevensJourney
Copy link
Collaborator

Overview

Our current API Reference docs don't include TypeScript interfaces. TypeScript interfaces can be critical for a TypeScript package's API documentation.

This PR configures Docusaurus to include interfaces in the docs output. These docs should exclude internal interfaces (which we should also prevent from being exported from the packages at some point in the furture). Additional @internal annotations have been added to cleanup the docs.

image

TODOS:

  • Add comments to undocumented items
  • Scan for additional internal items

Copy link

changeset-bot bot commented Jul 17, 2025

⚠️ No Changeset found

Latest commit: 00b1921

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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