Luna Stadler
8d18d23e34
* Replace underscores in techdocs titles Signed-off-by: Luna Stadler <luc@spreadshirt.net> * Make techdocs titles similar to component titles The pattern for components is entity name, page/tab and then app title. This ordering makes it easier to distinguish tabs at a glance. Signed-off-by: Luna Stadler <luc@spreadshirt.net> * Abbreviate nested pages in techdocs A deeply nested page like `/really/very/deeply/nested/page`, will now become "Really | ... | Nested | Page". This should preserve some of the context and support docs whith deeply nested pages. Signed-off-by: Luna Stadler <luc@spreadshirt.net> * Add changeset for TechDocs page title improvements Signed-off-by: Luna Stadler <luc@spreadshirt.net> * Display the full title based on all parts of the path Signed-off-by: Luna Stadler <luc@spreadshirt.net> --------- Signed-off-by: Luna Stadler <luc@spreadshirt.net>
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.