Files

T

Chris Suich ec7b35d77e feat: add techdocs-entity-path annotation for techdocs deep linking

This annotation enables specifying a path within another entities
techdocs to use as the root techdocs page.

Signed-off-by: Chris Suich <csuich2@gmail.com>

2025-04-28 11:32:28 -04:00

dev

chore: update react imports

2025-04-08 07:35:24 -05:00

src

feat: add techdocs-entity-path annotation for techdocs deep linking

2025-04-28 11:32:28 -04:00

.eslintrc.js

…

catalog-info.yaml

…

CHANGELOG.md

Version Packages (next)

2025-04-22 12:36:56 +00:00

config.d.ts

…

knip-report.md

…

package.json

Version Packages (next)

2025-04-22 12:36:56 +00:00

README.md

…

report-alpha.api.md

reports

2025-04-08 16:14:10 +02:00

report.api.md

reports

2025-04-08 16:14:10 +02:00

README.md

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.