pinecone-io / go-pinecone

Pinecone.io Golang Client
Apache License 2.0
49 stars 9 forks source link

Try new strategy for better rendering of documentation with gopages #45

Closed aulorbe closed 4 months ago

aulorbe commented 4 months ago

Problem

Our current documentation is quite ugly (https://sdk.pinecone.io/go/). We generated it by running godoc -url, which basically prints standard html to a file. We then pushed this static file to sdk-docs via that repo's README instructions.

Solution

There is a Go module called gopages: https://johnstarich.com/go/gopages/pkg/github.com/johnstarich/go/gopages/ that seemingly renders things better. We should try that to see if it looks nicer.

Type of Change

Test Plan

Need to merge to main, then trigger the documentation workflow in the sdk-docs repo to see the rendering.