docs: various tweaks and typo fixes

docqai · Sep 8, 2024 · a0dff37 · a0dff37
1 parent f9aff92
commit a0dff37
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 19 deletions.
diff --git a/docs/acknowledgement.md b/docs/acknowledgement.md
@@ -1,6 +1,6 @@
 # Acknowledgements
 
-The project would not have been possible without the following libraries:
+The project would not have been possible without the following projects:
 
 - [@jerryjliu](https://github.com/jerryjliu)'s [Llama Index](https://github.com/jerryjliu/llama_index)
 - [LiteLLM](https://github.com/BerriAI/litellm)
@@ -18,4 +18,9 @@ Which includes a set of beautiful Python build toolings such as:
 - [Ruff](https://github.com/astral-sh/ruff)
 - [OpenTelemetry](https://github.com/open-telemetry)
 
-This docs site is created using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
+Amazing tools used in deployments:
+
+- [Infisical](https://infisical.com/) - to manage secrets and environment variables easily.
+- [honeycomb.io](https://honeycomb.io) - backend for Open Telemetry trace data.
+
+This docs site is created using the wonderful [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
diff --git a/docs/developer-guide/web-api.md b/docs/developer-guide/web-api.md
@@ -1,5 +1,5 @@
 # Web API (alpha)
 
-Coming soon...
+We have a web API, which is used by the Chrome Extension. But the API is still too unstable for prime time and the DX isn't great yet so we are holding back from publishing it.
 
-[Join our Slack](https://join.slack.com/t/docqai/shared_invite/zt-27p17lu6v-6KLJxSmt61vfNqCavSE73A) to discuss
+But if you do have a use case we'd love to chat. [Join our Slack](https://join.slack.com/t/docqai/shared_invite/zt-27p17lu6v-6KLJxSmt61vfNqCavSE73A), jump on Twitter @docqai, or email <[email protected]> to discuss with our founders.
diff --git a/docs/overview/key-features.md b/docs/overview/key-features.md
@@ -31,9 +31,6 @@ Docq offers
 - a general chat interface with secure access to a LLM.
   ![General chat in Docq](../assets/Docq_general_chat.png)
 
-- a chat interface to do Q&A against individuals' own documents.
-  ![Ask private in Docq](../assets/Docq_ask_private.png)
-
 - A chat interface to gain insight by combing one's own documents with those shared within an organisation.
   ![Ask shared in Docq](../assets/Docq_ask_shared.png)
 

diff --git a/docs/user-guide/data-sources.md b/docs/user-guide/data-sources.md
@@ -5,6 +5,6 @@ Docq supports associating data to a Space is a varierty of ways. These are calle
 - Manual Upload
 - [Azure Blob](./config-spaces.md#data-source-azure-blob-container)
 - [Web Scraper](./config-spaces.md#data-source-web-scraper)
-- [Knowledgebase Scraper](./config-spaces.md#data-source-knowledgebase-scraper)
+- [Knowledge Base Scraper](./config-spaces.md#data-source-knowledgebase-scraper)
 - [Google Drive](./config-spaces.md#data-source-google-drive)
 - [OneDrive](./config-spaces.md#data-source-onedrive)
diff --git a/docs/user-guide/deploy-to-azure.md b/docs/user-guide/deploy-to-azure.md
@@ -4,11 +4,11 @@ In this deployment, you're going to utilise [Microsoft Cloud / Azure](https://az
 
 1. [Fork](https://github.com/docqai/docq/fork) the Docq repo at GitHub;
 2. Click this [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdocqai%2Fdocq%2Fmain%2Finfra%2Fazure%2Farm%2Fappservice.json) button to start the configuration wizard on Azure.
-   ![Azuere deploy whizard params screenshot](../assets/azure_deploy_params_screen.png)
+   ![Azure deploy wizard params screenshot](../assets/azure_deploy_params_screen.png)
 3. Resource group: create a new one by clicking the 'Create new' link next to the Resource Group label.
 4. Region: select your preferred region. `East US` or `West Europe` are recommended because of LLM support.
 5. Leave all the remaining parameters values as default unless you encounter a resource naming clash.
-6. Click 'Next: Reveiw + create'. Azure will validate the template + parameter values. You should see 'Validation Passed'.
-7. Click 'Create' to initiate resouece deployment. It will take 5-10mins. A successful deployment looks like the following.
+6. Click 'Next: Review + create'. Azure will validate the template + parameter values. You should see 'Validation Passed'.
+7. Click 'Create' to initiate resource deployment. It will take 5-10mins. A successful deployment looks like the following.
    ![Azure deploy complete screenshot](../assets/azure_deploy_complete.png)
-8. Click on the 'Outputs' left menu option to grab the URL to the Docq web app you just deployed.
+8. Click on the 'Outputs' left menu option to grab the URL to the Docq web app you just deployed.
diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md
@@ -14,16 +14,15 @@ To get you started, we show you one example for each scenario below.
 - For Secure Deployment, create a [Microsoft Cloud / Azure](https://azure.microsoft.com/) account with a secure foundation.
 - [Forking](https://github.com/docqai/docq/fork) the Docq repo at GitHub is highly recommended to have your own copy of code for your own deployment.
 
-
 ## Deployment Options
 
 - [Streamlit: 5 Minutes and flexible](./deploy-to-streamlit.md)
 
-- [Azure: 15 Minutes and decure](./deploy-to-azure.md)
+- [Azure: 15 Minutes and secure](./deploy-to-azure.md)
 
-- AWS: 15 Mintutes and Secure - on the roadmap
+- AWS: 15 Minutes and Secure - on the roadmap
 
-- GCP: 15 Mintutes and Secure - on the roadmap
+- GCP: 15 Minutes and Secure - on the roadmap
 
 ## After Deployment
 

diff --git a/docs/user-guide/llm-config.md b/docs/user-guide/llm-config.md
@@ -9,7 +9,7 @@ Find a little bit more information on how to get these credentials from each res
 ???+ warning
       In production, set secrets values in the shell. e.g. `set SOME_API_KEY=<your secret api key value>`.
 
-      A tool like Infisical helps manage this process while keeping your secret values safe.
+      A tool like [Infisical](https://infisical.com/) helps manage this process easily while keeping your secret values safe.
 
 ## OpenAI
 

diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -1,6 +1,6 @@
-site_name: Your private ChatGPT alternative.
+site_name: Your private ChatGPT.
 site_url: https://docqai.github.io/docq
-site_description: Docq offers self-hosted, private and secure ChatGPT on your private data with minimal onboarding and operational effort.
+site_description: Docq offers self-hosted, private and secure ChatGPT/Perplexity on your private data with minimal onboarding and operational effort.
 site_author: Docq Contributors
 copyright: Copyright &copy; 2023 - 2024 Docq Contributors
 site_dir: html