Files
backstage/plugins/techdocs
Marat Dyatko b32ab39670 Fix unsafe type casts via shared entityPresentationSnapshot utility
Extract entityPresentationSnapshot helper to eliminate unsafe `as Entity`
casts when passing CompoundEntityRef to EntityPresentationApi.forEntity(),
which only accepts Entity | string. The helper safely discriminates input
types and stringifies CompoundEntityRef before calling the API.

- Add entityPresentationSnapshot as a public export from catalog-react
- Remove duplicated getEntityTitle/getTitle helpers across 5 files
- Fix useAsync dependency array in TemplateFormPreviewer
- Update TSDoc across all presentation API surfaces to reference the
  new helper
- Update entity-presentation.md docs with usage guidance and migration
  table

Made-with: Cursor
Signed-off-by: Marat Dyatko <maratd@spotify.com>
2026-04-07 12:41:29 +02:00
..
2025-04-08 07:35:24 -05:00
2026-03-24 14:54:00 +00:00
2026-03-24 14:54:00 +00:00
2026-03-20 14:09:58 +01:00

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by following our guide on Getting Started.

Configuration

Refer to our configuration reference for a complete listing of configuration options.

TechDocs Storage API

The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of <storageUrl>/<entity namespace>/<entity kind>/<entity name>. This can be configured by implementing a new techdocs storage API.