Update documentation for v3.0 release (#284)

Update the docs and bring back the docs publishing workflow step.

Author: jhamon

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

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

.github/workflows/merge.yaml

@@ -1,4 +1,4 @@
-name: 'Merge to main'
+name: 'CI (main)'
 
 on:
   push:
@@ -18,15 +18,15 @@ jobs:
         with:
           python-version: 3.11
 
-      # - name: Push documentation artifacts to sdk-docs
-      #   uses: cpina/github-action-push-to-another-repository@main
-      #   env:
-      #     SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
-      #   with:
-      #     source-directory: docs
-      #     destination-github-username: pinecone-io
-      #     destination-repository-name: sdk-docs
-      #     user-email: [email protected]
-      #     target-branch: main
-      #     target-directory: python
-      #     commit-message: 'Python: automated documentation build - pinecone-python-client merge SHA: ${{ github.sha }}'
+      - name: Push documentation artifacts to sdk-docs
+        uses: cpina/github-action-push-to-another-repository@main
+        env:
+          SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
+        with:
+          source-directory: docs
+          destination-github-username: pinecone-io
+          destination-repository-name: sdk-docs
+          user-email: [email protected]
+          target-branch: main
+          target-directory: python
+          commit-message: 'Python: automated documentation build - pinecone-python-client merge SHA: ${{ github.sha }}'

CONTRIBUTING.md

@@ -1,5 +1,22 @@
 # Contributing 
 
+## Installing development versions
+
+If you want to explore a potential code change, investigate
+a bug, or just want to try unreleased features, you can also install
+specific git shas.
+
+Some example commands:
+
+```shell
+pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git
+pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git@example-branch-name
+pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git@44fc7ed
+
+poetry add git+https://github.com/pinecone-io/pinecone-python-client.git@44fc7ed
+```
+
+
 ## Developing locally with Poetry 
 
 [Poetry](https://python-poetry.org/) is a tool that combines [virtualenv](https://virtualenv.pypa.io/en/latest/) usage with dependency management, to provide a consistent experience for project maintainers and contributors who need to develop the pinecone-python-client