docs(techdocs): added intro, features, roadmap

2020-07-14 11:07:56 +02:00
parent d4d54ee7e3
commit a1565b30f7
1 changed files with 29 additions and 1 deletions
@@ -2,7 +2,35 @@

 ## What is it?

-Intro, backstory, etc.
+<!-- Intro, backstory, etc.: -->
+
+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 ✅][v0]   | Read docs in Backstage - Enable anyone to get a reader experience working in Backstage.                                  |
+| [TechDocs V.1 🚧][v1]   | TechDocs end to end - First and minimum release of TechDocs that you can use end to end - and contribute to.             |
+| [TechDocs V.2 🔮⌛][v2] | Widget Architecture - TechDocs widget architecture available, so the community can create their own customized features. |
+
+[v0]: https://github.com/spotify/backstage/milestone/15
+[v1]: https://github.com/spotify/backstage/milestone/16
+[v2]: https://github.com/spotify/backstage/milestone/17

 ## Structure