Closed aulorbe closed 4 months ago
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.
godoc -url
sdk-docs
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.
gopages
Need to merge to main, then trigger the documentation workflow in the sdk-docs repo to see the rendering.
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 tosdk-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.