Add Reference documentation status badge - Githubissues

pinecone-io / go-pinecone

Pinecone.io Golang Client

Apache License 2.0

49 stars 9 forks source link

Add Reference documentation status badge #40

Closed rockwotj closed 4 months ago

rockwotj commented 4 months ago

Problem

Hard to get to reference documentation.

Solution

I tried to look on the offical pinecone website but the docs are quite sparse. Getting to the godoc took too many clicks.

Type of Change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
[ ] Infrastructure change (CI configs, etc)
[x] Non-code change (docs, etc)
[ ] None of the above: (explain here)

Test Plan

Clicked the link.

aulorbe commented 4 months ago

Just fyi @rockwotj, you can find the latest documentation from the main branch here now :) https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone (see this PR for more info)

rockwotj commented 4 months ago

Awesome thank you, already used it once :)