TechDocs

Write docs alongside code, but read them in your portal. Roadie's TechDocs renders all your documentation in one place—centralized yet distributed.

RoadieSearch⌘+KHomeCatalogAPIsDocsTech InsightsTemplatesCatalog GraphTech RadarCost InsightsDocumentationRoadie — The Main Roadie appA newer version of this documentation is now available, please refresh to view.REFRESHSearch Roadie docsRoadieRoadie Backstage Appli…Coding conventionsRoadie agentTech insightsRoadie Backstage Application✎ ⧉The main Roadie application is a Backstage instance with custom plugins and configuration.Built with React and TypeScript; deployed as a container image.Uses the Roadie catalog for entity metadata and TechDocs for documentation.Building1yarn install2yarn build3yarn startNext: Coding conventions →

Trusted by the world's leading companies

Snyk
Contentful
Relativity
Royal Mail
Baillie Gifford
Celonis
AstraZeneca
Yotpo
TECHDOCS FEATURES

No more shuffling for documentation

Markdown files that live next to code, rendered in your portal. API specs, runbooks, and guides—all discoverable in one place.

Docs-as-Code

Documentation lives next to the code it describes. Markdown files in your repos, rendered beautifully in your portal. Developers update docs alongside code changes.

Centralized reading

Stop shuffling between Confluence, README files, Swagger, and team Docusaurus sites. All documentation renders in one place—your Internal Developer Portal.

API specs included

OpenAPI, AsyncAPI, GraphQL, gRPC—all rendered alongside your services. Discover an API in the catalog and learn how to use it on the spot.

Full-text search

Search across all documentation from a single search bar. Find what you need without knowing which repo or wiki it lives in.

Organized by entity

Documentation is linked to catalog entities. Navigate to a service and find its docs, runbooks, and API specs in context.

No vendor lock-in

TechDocs is open-source Backstage. Your markdown files stay in your repos. Switch to self-hosted Backstage anytime if you outgrow our solution.
WHY TECHDOCS

Documentation that stays current

Outdated documentation is counterproductive. TechDocs keeps docs fresh by design.

01

Keep docs fresh

When docs live with code, developers update them as part of their normal workflow. No more stale wikis.

02

Reduce context switching

Everything about a service—code, docs, APIs, runbooks—lives together. One place to look, always.

03

Improve discoverability

New engineers find documentation through the catalog. No tribal knowledge required to know where docs live.

We started moving all of our documentation into Backstage through Roadie. They are great to work with and super responsive and helpful.