Fix minor README docs issues in client reference #316
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
@haruska pointed out that the headers in the SDK client reference navigation bar were a little off for "Create Index" showing "Create a pod index" only. The formatting also felt a bit off with everything being aligned.
https://sdk.pinecone.io/python/pinecone.html
While fixing this I also noticed the link for the
CONTRIBUTING.md
file is relative in the README, which doesn't work when linking from our generated docs.Solution
Create Index
to the header and movingCreate a serverless index
andCreate a pod index
to sub-headers of that.CONTRIBUTING.md
file.Type of Change
Test Plan
You can pull this branch down and build the docs locally. You'll need to make sure to install the grpc extras with poetry:
This will build the docs in the
/docs
folder under the project folder. You can open theindex.html
file locally.