Add top level list of links

Signed-off-by: Rohan Chitale <[email protected]>

Author: rchitale7

API.md

@@ -41,7 +41,7 @@ Request Response:
 * The top two parameters are derived by the KNN plugin from the customer's repo setting. `container_name` is used to specifically refer to the "bucket" (or non-S3 equivalent), rather than the name of the repository itself.
 * Tenant ID is included to be used for billing, authorization, etc
 * Dimension, doc count, and data type are specifically placed on the first JSON level so the build service can quickly use them first to calculate workload size
-* Doc count must be greater than 4, since doc counts of 1, 3, and 4 have been observed to consistently fail during index builds
+* Doc count must be greater than 4, since doc counts of 1, 3, and 4 have been observed to consistently fail during index builds. There is currently an issue open with faiss for this: https://github.com/facebookresearch/faiss/issues/4260
 * Engine: If in the future we have different workers hosting different engines, like Lucene etc. this parameter will act as an extension point. This is not a required parameter.
 * Space type is inside `index_parameters` since it is only used in index creation
 * By including an `algorithm` field in index parameters, we leave the door open for IVF, future algorithms

DEVELOPER_GUIDE.md

@@ -9,6 +9,9 @@
 - [Building Docker Images](#building-docker-images)
     - [Faiss Base Image](#faiss-base-image)
     - [Core Image](#core-image)
+    - [API Image](#api-image)
+- [Running Docker Images](#running-docker-images)
+    - [Run the API Image as a standalone container](#run-the-api-image-as-standalone-container)
 - [Provisioning an Instance for Development](#provisioning-an-instance-for-development)
 - [Memory Profiling](#memory-profiling)
     - [GPU Memory Profiling with NVIDIA SMI](#gpu-memory-profiling-with-nvidia-smi)