Files

T

Johan Persson 2a57064226 docs(ui): comprehensive documentation improvements for all components

Improves documentation quality and consistency across all UI components.

Props documentation:
- Added descriptions to all props across all components
- Fixed prop types to match source implementations
- Added missing props (onAction, isInvalid, aria-label, etc.)
- Corrected default values and removed non-existent props
- Converted props-definition files to .tsx for Chip component usage

Examples and snippets:
- Added side-by-side layout option to Snippet component
- Fixed snippet/preview mismatches
- Improved example code indentation and formatting
- Added live previews to Container, Box, Grid examples
- Wrapped Skeleton examples in themed Box for visibility

API reference:
- Added ReactAriaLinks to all components
- Updated React Aria URLs to react-aria.adobe.com format
- Cleaned up verbose prose and standardized descriptions

Other:
- Updated PageTitle descriptions to 5-12 word format
- Varied example intro phrasing for consistency

Signed-off-by: Johan Persson <johanopersson@gmail.com>

2026-01-28 14:09:26 +01:00

public

Adding docs for Alert

2026-01-26 18:37:28 +00:00

scripts

Merge pull request #32516 from backstage/freben/nodecolon

2026-01-27 14:17:14 +01:00

src

docs(ui): comprehensive documentation improvements for all components

2026-01-28 14:09:26 +01:00

.eslintrc.json

…

.gitignore

…

next.config.mjs

Cleaning build

2025-11-04 14:30:54 +00:00

package.json

Add new changelog structure

2026-01-23 18:34:28 +00:00

README.md

feat(docs-ui): add automated changelog sync from @backstage/ui

2025-11-17 11:37:39 +01:00

tsconfig.json

…

yarn.lock

Merge pull request #32435 from backstage/renovate/nextjs-monorepo

2026-01-22 11:53:53 +01:00

README.md

Backstage UI Docs

Backstage UI is our internal UI library built for Backstage. We built this website to document the library and its components. You can view this website here.

How to run locally

This website is built with Next.js and it is hosted on Github pages. To run it locally, you can run the following command:

yarn start

Deployment

Deployments are done automatically when a PR is merged into the master branch. We host the website using Github pages.

Maintaining Component Changelogs

After a @backstage/ui release, sync the component changelogs to keep documentation up-to-date:

yarn sync:changelog

This script:

Parses packages/ui/CHANGELOG.md for new versions
Extracts entries tagged with "Affected components: ..."
Updates src/utils/changelog.ts with new entries
Handles both component-specific and general package changes

After running, review the changes in src/utils/changelog.ts and commit them.

Preview changes before writing:

yarn sync:changelog:dry-run

Running this gives you a summary of what would be written, without actually adding or changing any files.