No more shuffling around for docs

Roadie’s Tech Docs lets developers write docs alongside code, but read them in their Internal Developer Portal.

Try Roadie's Docs
All my docs plz

Keep org-wide documentation organized

Roadie makes your documentation easier to discover

Shuffling between Confluence, README files, swagger, and your team's Docusaurus takes a lot of time. Roadie’s TechDocs lets you render all your documentation in one place. Make sure everyone has access to the latest documentation version in a single place: their Internal Developer Portal.

## How to release
This plugin uses the [npm-publish-action](https://github.com/marketplace/actions/publish-to-npm) Github Action to automate releases. It expects commits to be titled in a very specific way.
To publish a new version:

Centralized yet distributed Docs-as-Code

Developers maintain docs alongside their codebase

Outdated documentation is often counterproductive. Roadie’s Tech Docs are markdown files that to live next to the code they document, so developers can update them easily. Roadie will go through your repos looking for documentation entries and bring them all into your Internal Developer Portal.

A home for all API Specs

Bring in OpenAPI, AsyncAPI, GraphQL, gRPC and custom API docs

Minimize context switching by letting devs discovering an API in the catalog and learning how to use it on the spot. When your teams register API into the Roadie Catalog, they can let it render their endpoints documentation right within the corresponding entity page. Roadie will also have an aggregated view page for developers to have a single reference for all API docs.

Snyk logo
“We started moving all of our documentation into Backstage through Roadie. I totally recommend them. They’re great to work with and super responsive and helpful.”
Andy Hoffman Headshot
Crystal HirshcornDirector of Engineering at Snyk
Simpler, safer, and more powerful Backstage.Request a Demo