Documentation updates (#450)

## Problem

Need to overhaul README, other markdown docs, and docstrings to reflect
recent changes and additions to the SDK.

## Solution

<img width="600" alt="Kermit typing meme"
src="https://media1.giphy.com/media/v1.Y2lkPTc5MGI3NjExeHV4cTM1cjhsYWtmbG03aHgwZ3hleXM2OTUzbzI1YnN2dmloN3BidSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/LmBsnpDCuturMhtLfw/giphy.gif"
/>

Author: jhamon

.github/actions/build-docs/action.yml

@@ -21,4 +21,4 @@ runs:
     - name: Build html documentation
       shell: bash
       run: |
-        poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./docs
+        poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./pdoc

.github/workflows/build-and-publish-docs.yaml

@@ -24,7 +24,7 @@ jobs:
         env:
           SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
         with:
-          source-directory: docs
+          source-directory: pdoc
           destination-github-username: pinecone-io
           destination-repository-name: sdk-docs
           user-email: [email protected]

.gitignore

@@ -141,9 +141,9 @@ venv.bak/
 # pdocs documentation
 #   We want to exclude any locally generated artifacts, but we rely on
 #   keeping documentation assets in the docs/ folder.
-docs/*
-!docs/pinecone-python-client-fork.png
-!docs/favicon-32x32.png
+pdoc/*
+!pdoc/pinecone-python-client-fork.png
+!pdoc/favicon-32x32.png
 
 # mypy
 .mypy_cache/