[DEPRIORITISED] update docs to add link to redoc

README.md

@@ -63,7 +63,7 @@ To get answers from your database of contents, you can use the `/search` endpoin
 - Search results: Finds the most similar content in the database using cosine distance between embeddings.
 - (Optionally) LLM generated response: Crafts a custom response using LLM chat using the most similar content.
 
-See [docs](https://docs.ask-a-question.com/) or [API docs](https://app.ask-a-question.com/api/docs) for more details and other API endpoints.
+See [docs](https://docs.ask-a-question.com/) or [API docs](https://app.ask-a-question.com/api/redoc) for more details and other API endpoints.
 
 ### :question: Simple content search
 

core_backend/app/__init__.py

@@ -28,6 +28,8 @@
 🔑 <a href="https://app.ask-a-question.com/integrations" target="_blank">Get your API
 key</a> |
 📖 <a href="https://docs.ask-a-question.com" target="_blank">Docs</a> |
+☁️ <a href="https://app.ask-a-question.com/api/redoc" target="_blank">APIs</a> |
+🧪 <a href="https://app.ask-a-question.com/api/docs" target="_blank">Test APIs</a> |
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="1em"
 style="vertical-align: bottom;"><path d="m0 0h24v24h-24z" fill="#fff" opacity="0"
 transform="matrix(-1 0 0 -1 24 24)"/><path d="m12 1a10.89 10.89 0 0 0 -11 10.77 10.79

docs/components/qa-service/index.md

@@ -48,13 +48,10 @@ as text, or as both.
 <img src="./swagger-ui-screenshot.png" alt="Screenshot of Swagger UI" style="border: 1px solid  lightgray;">
 
 If you have the [application running](../../deployment/quick-setup.md), you can access
-the SwaggerUI at
+the SwaggerUI at `https://[DOMAIN]/api/docs` and Redoc at `https://[DOMAIN]/api/redoc`
 
-    https://[DOMAIN]/api/docs
-
-or if you are using the [dev](../../develop/setup.md) setup:
-
-    http://localhost:8000/docs
+or if you are using the [dev](../../develop/setup.md) setup,
+`http://localhost:8000/docs` and `http://localhost:8000/redoc`.
 
 ## Upcoming
 

docs/usage.md

@@ -10,7 +10,7 @@ To get answers from your database of contents, you can use the `/search` endpoin
 - Search results: Finds the most similar content in the database using cosine distance between embeddings.
 - (Optionally) LLM generated response: Crafts a custom response using LLM chat using the most similar content.
 
-You can also add your contents programatically using API endpoints. See [docs](https://docs.ask-a-question.com/) or SwaggerUI at `https://<DOMAIN>/api/docs` or `https://<DOMAIN>/docs` for more details and other API endpoints.
+You can also add your contents programatically using API endpoints. See our [API docs](https://app.ask-a-question.com/api/redoc) for more details and other API endpoints.
 
 ### :question: Embeddings search
 
@@ -44,14 +44,14 @@ curl -X 'POST' \
 
 ## Admin app
 
-You can access the admin console at
+You can access the admin app of AAQ's cloud version [here](https://app.ask-a-question.com). You can
+also [self-host your own AAQ admin app](http://localhost:8080/deployment/quick-setup/).
 
-```
-https://[DOMAIN]/
-```
-
-On the [Admin app]("./content/admin-app.md"), you can:
+On the admin app, you can:
 
 - :books: Manage content for more details
 - :test_tube: Use the playground to test the Question-Answering service
 - :bar_chart: View dashboards
+
+See more detailed documentation of the admin app
+[here](http://localhost:8080/components/admin-app/).

mkdocs.yml

@@ -70,7 +70,7 @@ nav:
   - Contact us:
       - Team: contact_us.md
 
-  - API docs ↗︎: https://app.ask-a-question.com/api/docs
+  - API docs ↗︎: https://app.ask-a-question.com/api/redoc
 
 # Themes and extensions
 theme: