feat(docs): autogenerate documentation from the API specs

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-12-11 18:35:56 -07:00
parent f41aec8345
commit b2831706d5
10 changed files with 3799 additions and 52 deletions
@@ -0,0 +1,16 @@
+---
+id: 404
+title: Unable to find API docs
+sidebar_label: API
+description: Unable to find the requested API docs.
+---
+
+## API Docs Missing
+
+If you're seeing this page at backstage.io/docs, please open an issue in the main repository. Something is wrong.
+
+If you're seeing this page locally and you want to see the actual API docs for this plugin, you need to
+
+1. cd into the `microsite/` directory.
+2. run `yarn generate-openapi-docs` to generate the API docs.
+3. rerun `yarn start` to pick up the new generated docs.