Skip to content

docs: add TSDoc prop documentation for all components#2176

Open
somerandomdude wants to merge 18 commits intov4-monorepofrom
pjo-v4-monorepo-component-documentation
Open

docs: add TSDoc prop documentation for all components#2176
somerandomdude wants to merge 18 commits intov4-monorepofrom
pjo-v4-monorepo-component-documentation

Conversation

@somerandomdude
Copy link
Copy Markdown

Description

Added TypeDocs to all UI4 components–specifically for props documentation

What to review

All component props will need an additional review to vet accuracy.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 23, 2026

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

Project Deployment Actions Updated (UTC)
sanity-ui-storybook Ready Ready Preview Feb 27, 2026 8:03am
sanity-ui-workshop Ready Ready Preview, Comment Feb 27, 2026 8:03am

Request Review

@socket-security
Copy link
Copy Markdown

socket-security bot commented Feb 24, 2026

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatednpm/​eslint-formatter-gha@​1.6.0 ⏵ 2.0.197 +31007683 +5100
Updatednpm/​baseline-browser-mapping@​2.8.16 ⏵ 2.10.0100100100 +195100

View full report

@kristofferlund kristofferlund force-pushed the pjo-v4-monorepo-component-documentation branch from 3bd82f9 to 4bf572d Compare February 25, 2026 10:09
colepeters

This comment was marked as duplicate.

somerandomdude and others added 3 commits February 26, 2026 09:38
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
somerandomdude and others added 7 commits February 26, 2026 09:40
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Co-authored-by: Cole Peters <cole@colepeters.com>
Copy link
Copy Markdown
Member

@colepeters colepeters left a comment

Choose a reason for hiding this comment

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

For posterity: we’ve reviewed and approved the Typedocs for:

  • Box
  • Flex
  • Stack
  • Card
  • Button
  • Text

These have been identified as the most commonly used Sanity UI components.

As the rest of the generated typedocs represents a substantial amount of code, and the typedocs generated for these six components weren't problematic (even if they're not ideal), we're proceeding with merging these to verify if these improve AI assistant usage of the components.

We’ll aim to review the remaining typedocs prior to making Sanity UI 4 the stable version of the package.

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.

3 participants