Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix minor README docs issues in client reference #316

Merged
merged 1 commit into from Feb 23, 2024

Conversation

austin-denoble
Copy link
Contributor

@austin-denoble austin-denoble commented Feb 23, 2024

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

  • Promote "Indexes" to a top-level section to visually break up the nav list a bit, and then swap Create Index to the header and moving Create a serverless index and Create a pod index to sub-headers of that.
  • Link directly to github for the CONTRIBUTING.md file.

Type of Change

  • Non-code change (docs, etc)

Test Plan

Before After
Screenshot 2024-02-23 at 12 55 08 PM Screenshot 2024-02-23 at 12 55 32 PM

You can pull this branch down and build the docs locally. You'll need to make sure to install the grpc extras with poetry:

poetry install --extras "grpc"
poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./docs

This will build the docs in the /docs folder under the project folder. You can open the index.html file locally.

Copy link

@haruska haruska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning this up!

@austin-denoble austin-denoble merged commit 1235fbd into main Feb 23, 2024
124 checks passed
@austin-denoble austin-denoble deleted the adenoble/fix-readme-docs branch February 23, 2024 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants