ellieseastreamTechDocs Documentation
What is it?
Wait, what is TechDocs? TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage. Today, it is now one of the core products in Spotify’s developer experience offering with 2,400+ documentation sites and 1,000+ engineers using it daily.
Features
-
A centralized place to discover documentation.
-
A clear end-to-end docs-like-code solution. (Coming soon in V.1)
-
A tightly coupled feedback loop with the developer workflow. (Coming soon in V.2)
-
A developer ecosystem for creating extensions. (Coming soon in V.2)
Project roadmap
| Version | Description |
|---|---|
| TechDocs V.0 ✅ | Read docs in Backstage - Enable anyone to get a reader experience working in Backstage. |
| TechDocs V.1 🚧 | TechDocs end to end - First and minimum release of TechDocs that you can use end to end - and contribute to. |
| TechDocs V.2 🔮⌛ | Widget Architecture - TechDocs widget architecture available, so the community can create their own customized features. |
Structure
- Getting Started
- Concepts
- Reading Documentation
- Writing Documentation
- Publishing Documentation
- Contributing
- Debugging
- FAQ
Tech Stack
| Stack | Location |
|---|---|
| Frontend | @backstage/plugin-techdocs |
| Backend | @backstage/plugin-techdocs-backend |
| Docker Container (for generating doc sites) | packages/techdocs-container |
| CLI (for local development) | packages/techdocs-cli |