SEO improvements

mithril-security · Nov 10, 2023 · 44d5806 · 44d5806
1 parent 367db7e
commit 44d5806
Show file tree

Hide file tree

Showing 22 changed files with 52 additions and 0 deletions.
diff --git a/docs/docs/advanced/build-from-sources/client.md b/docs/docs/advanced/build-from-sources/client.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Build BlindAI Client SDK on Linux/Windows: Follow our guide for dependencies, instructions, and development empowerment.">
+
 # Build the BlindAI Client SDK from source
 _________________________________________________
 

diff --git a/docs/docs/advanced/build-from-sources/server.md b/docs/docs/advanced/build-from-sources/server.md
@@ -1,3 +1,5 @@
+<meta name="description" content="BlindAI server building guide: Ensure dependencies and hardware readiness, and follow steps for a secure setup.">
+
 # Build the server from source
 
 !!! info

diff --git a/docs/docs/advanced/contributing/blindai-project-structure.md b/docs/docs/advanced/contributing/blindai-project-structure.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Explore BlindAI's codebase structure: client, server, docs, and more for insightful organization of secure AI solutions.">
+
 # BlindAI Project Structure
 
 Let us introduce you to the project directory structure for BlindAI.

diff --git a/docs/docs/advanced/contributing/code_of_conduct.md b/docs/docs/advanced/contributing/code_of_conduct.md
@@ -1,3 +1,5 @@
+<meta name="description" content="BlindAI's inclusive community: Learn our Code of Conduct for respectful interaction and healthy environment maintenance.">
+
 # Contributor Covenant Code of Conduct
 ________________________________________
 

diff --git a/docs/docs/advanced/contributing/contributing.md b/docs/docs/advanced/contributing/contributing.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Contribute to BlindAI: Follow our guide for issue reporting, enhancements, and pull requests while upholding conduct standards.">
+
 # Contributing to BlindAI 
 _________________________________
 

diff --git a/docs/docs/advanced/contributing/setting-up-your-dev-environment.md b/docs/docs/advanced/contributing/setting-up-your-dev-environment.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Set up BlindAI development: Clone the repository, install dependencies, and compile client/server for confident contribution.">
+
 ### Development environment
 If you want to make changes to the code, it is recommended you use our pre-configured development container, which contains all the dependencies you need to run and use blindai.
 

diff --git a/docs/docs/advanced/verify_blindai.md b/docs/docs/advanced/verify_blindai.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Learn BlindAI's code integrity and security through remote attestation, with SGX2 machine testing for unauthorized modification protection.">
+
 ### Verifying code integrity checks in BlindAI
 
 The code integrity checks are part of the remote attestation process in BlindAI. It is a key security check which checks that the BlindAI application running in our server instance has not been tampered with.

diff --git a/docs/docs/concepts/BlindAI_Core.md b/docs/docs/concepts/BlindAI_Core.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Discover BlindAI Core: Secure AI model serving with remote attestation, Python API, and hardware security for data protection.">
+
 # BlindAI Core: Overview
 ________________________________________
 

diff --git a/docs/docs/concepts/SGX_vs_Nitro.md b/docs/docs/concepts/SGX_vs_Nitro.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Explore Intel SGX vs. Nitro Enclaves in BlindAI: Attestation, Trusted Computing Bases, and data privacy in secure environments.">
+
 # Secure Enclaves
 ________________________________________
 

diff --git a/docs/docs/getting-started/blindai_structure.md b/docs/docs/getting-started/blindai_structure.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Access AI models privately with BlindAI: Learn about API, Whisper integration, and secure model deployment with BlindAI Core.">
+
 # How is BlindAI structured?
 ________________
 

diff --git a/docs/docs/getting-started/confidential_computing.md b/docs/docs/getting-started/confidential_computing.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Understand BlindAI's data protection through Confidential Computing, Trusted Execution Environments, and attestation.">
+
 # How does BlindAI protect your data?
 _________________________________
 

diff --git a/docs/docs/getting-started/quick-tour.ipynb b/docs/docs/getting-started/quick-tour.ipynb
@@ -7,6 +7,8 @@
     "id": "7-tQfVM_pJcr"
    },
    "source": [
+    "<meta name=\"description\" content=\"Quick Tour of BlindAI API: Open-source Python library for private AI model access and Whisper model audio transcription.\">\n",
+    "\n",
     "<div id=\"colab_button\">\n",
     "  <h1>Quick tour</h1>\n",
     "  <a target=\"_blank\" href=\"https://colab.research.google.com/github/mithril-security/blindai/blob/main/docs/docs/getting-started/quick-tour.ipynb\"> \n",

diff --git a/docs/docs/getting-started/why-blindai.md b/docs/docs/getting-started/why-blindai.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Why choose BlindAI: AI model deployment with privacy in cloud/on-premise, using confidential computing and Intel SGX.">
+
 # Why BlindAI?
 ________________
 

diff --git a/docs/docs/how-to-guides/covid_net_confidential.ipynb b/docs/docs/how-to-guides/covid_net_confidential.ipynb
@@ -7,6 +7,8 @@
     "id": "EPRppfayqvHD"
    },
    "source": [
+    "<meta name=\"description\" content=\"Secure AI model deployment with BlindAI for private Covid-19 diagnosis. Data privacy with SGX enclaves.\">\n",
+    "\n",
     "<div id=\"colab_button\">\n",
     "  <h1>Confidential diagnosis with Covid-NET</h1>\n",
     "  <a target=\"_blank\" href=\"https://colab.research.google.com/github/mithril-security/blindai/blob/main/docs/docs/how-to-guides/covid_net_confidential.ipynb\"> \n",

diff --git a/docs/docs/security/remote_attestation.md b/docs/docs/security/remote_attestation.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Improve SEO with our Intel SGX Remote Attestation guide: Learn secure enclave verification through ECDSA attestation.">
+
 # Remote attestation Implementation
 __________________________________________
 

diff --git a/docs/docs/security/threat_model.md b/docs/docs/security/threat_model.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Comprehend BlindAI's Threat Model for Intel SGX and Fortanix EDP: Threat agents, potential risks, and mitigation strategies.">
+
 # Threat model
 __________________________________________
 

diff --git a/docs/docs/tutorials/api/coming_soon.md b/docs/docs/tutorials/api/coming_soon.md
@@ -1,3 +1,5 @@
+<meta name="description" content="BlindAI's open-source models with privacy: Explore Whisper ASR system and OpenChatKit for chatbots, with privacy tutorials.">
+
 # BlindAI API models
 _________________________________
 

diff --git a/docs/docs/tutorials/api/whisper_tutorial.ipynb b/docs/docs/tutorials/api/whisper_tutorial.ipynb
@@ -7,6 +7,8 @@
     "id": "7-tQfVM_pJcr"
    },
    "source": [
+    "<meta name=\"description\" content=\"Transcribe audio privately with Whisper and BlindAI API: Install Python library, transcribe securely with hardware attestation.\">\n",
+    "\n",
     "<div id=\"colab_button\">\n",
     "  <h1>Whisper integration</h1>\n",
     "  <a target=\"_blank\" href=\"https://colab.research.google.com/github/mithril-security/blindai/blob/main/docs/docs/tutorials/api/whisper_tutorial.ipynb\"> \n",

diff --git a/docs/docs/tutorials/core/installation.md b/docs/docs/tutorials/core/installation.md
@@ -1,3 +1,5 @@
+<meta name="description" content="BlindAI installation guide: Test without hardware security, deploy on Azure DCsv3 VM, and set up on-premise with Intel SGX+FLC.">
+
 # Installation
 ________________________________
 

diff --git a/docs/docs/tutorials/core/uploading_models.ipynb b/docs/docs/tutorials/core/uploading_models.ipynb
@@ -7,6 +7,8 @@
     "id": "WJ9jprifq1aH"
    },
    "source": [
+    "<meta name=\"description\" content=\"Upload and test ML models securely on BlindAI server: Ensure user data privacy and security during AI model deployment.\">\n",
+    "\n",
     "<div id=\"colab_button\">\n",
     "  <h1>Uploading models</h1>\n",
     "  <a target=\"_blank\" href=\"https://colab.research.google.com/github/mithril-security/blindai/blob/main/docs/docs/tutorials/core/uploading_models.ipynb\"> \n",

diff --git a/docs/generate_api_reference.sh b/docs/generate_api_reference.sh
@@ -1,8 +1,18 @@
+#!/bin/bash
+
 # script to generate the python API reference
 # pdoc3 must be installed (pip install pdoc3)
 pip install pdoc3   
 pdoc --html --skip-errors --template-dir docs/pdoc_template -o docs/ client/blindai --force
 sed -i '/<p>Generated by <a href="https:\/\/pdoc3.github.io\/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc<\/cite> 0.10.0<\/a>.<\/p>/d' docs/blindai/*.html
+sed -i '/<head>/a <meta name="description" content="Explore BlindAI\'s \'Audio\' class for Whisper-based audio-text transcription in Python, with Trusted Execution Environment support.">' docs/blindai/api.html
+sed -i '/<head>/a <meta name="description" content="Use \'BlindAI Audio\' for Whisper-powered audio-text conversion\; ensure security with Trusted Execution Environments.">' docs/blindai/audio.html
+sed -i '/<head>/a <meta name="description" content="Learn \'blindai.client\' for secure AI server connections, model uploads, and inferences. Boost data security with Python client module.">' docs/blindai/client.html
+sed -i '/<head>/a <meta name="description" content="Dive into \'blindai.core\': Secure server connections, attestation, and privacy-focused features in BlindAI\'s core module.">' docs/blindai/core.html
+sed -i '/<head>/a <meta name="description" content="Uncover \'BlindAI\' package: AI privacy, audio processing, secure connections, and more in a robust Python toolkit.">' docs/blindai/index.html
+sed -i '/<head>/a <meta name="description" content="Master BlindAI testing: Start mock servers, validate AI solutions, and improve performance with BlindAI\'s testing tools.">' docs/blindai/testing.html
+sed -i '/<head>/a <meta name="description" content="Use \'blindai.utils\' for utility functions like certificate conversion and Whisper Tiny 20 tokens. Streamline AI workflows.">' docs/blindai/utils.html
+
 # script to generate the python API reference
 # pdoc3 must be installed (pip install pdoc3)
 set -e
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,5 @@
+<meta name="description" content="Discover BlindAI: Open-source AI privacy via Trusted Execution Environments and Python for secure model querying.">
+
 # 👋 Welcome to BlindAI!
 ________________________________________________________