Skip to content

fix(repo): Add standalonePage tag for JSDoc comments#8524

Merged
alexisintech merged 3 commits into
aa/generate-object-docsfrom
aa/standalonepage-tag
May 12, 2026
Merged

fix(repo): Add standalonePage tag for JSDoc comments#8524
alexisintech merged 3 commits into
aa/generate-object-docsfrom
aa/standalonepage-tag

Conversation

@alexisintech
Copy link
Copy Markdown
Member

@alexisintech alexisintech commented May 12, 2026

Description

We were getting errors that certain files weren't being generated anymore. More information here: #8276 (comment)

This PR adds a @standalonePage tag that can be used in conjunction with the @inline tag to indicate to typedoc to still generate a dedicated page for that type, even though it is recognized as @inline. Using both of these tags means that the type will show up as inlined in a table, but will also still have a generated MDX file.
For example:
HookParams will be inlined in a table:
Screenshot 2026-05-11 at 17 22 38
but will still get a generated shared/hook-params.mdx file that can then be used in the docs:
Screenshot 2026-05-11 at 17 23 22

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2026

⚠️ No Changeset found

Latest commit: 9e29238

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

@alexisintech alexisintech requested a review from SarahSoutoul May 12, 2026 00:23
@vercel
Copy link
Copy Markdown

vercel Bot commented May 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 12, 2026 8:11pm

Request Review

Comment thread .typedoc/standalone-page-tag.mjs Outdated
Copy link
Copy Markdown
Contributor

@SarahSoutoul SarahSoutoul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good!

One non-blocking follow-up: we may want to add .typedoc/standalone-page-tag.mjs to the Typedoc inputs in turbo.json so Turbo invalidates the cache when that script changes.

@SarahSoutoul SarahSoutoul self-assigned this May 12, 2026
@alexisintech
Copy link
Copy Markdown
Member Author

This looks good!

One non-blocking follow-up: we may want to add .typedoc/standalone-page-tag.mjs to the Typedoc inputs in turbo.json so Turbo invalidates the cache when that script changes.

oh cool! done 9e29238

@alexisintech alexisintech marked this pull request as ready for review May 12, 2026 20:11
@alexisintech alexisintech merged commit 847d2a6 into aa/generate-object-docs May 12, 2026
6 of 7 checks passed
@alexisintech alexisintech deleted the aa/standalonepage-tag branch May 12, 2026 20:11
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.

2 participants