-
Notifications
You must be signed in to change notification settings - Fork 9
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
Remove GH workflow and actions to generate documentation #47
Conversation
@@ -10,7 +10,7 @@ jobs: | |||
steps: | |||
- uses: actions/checkout@v4 | |||
- name: Setup Go | |||
uses: actions/setup-go@v4 | |||
uses: actions/setup-go@v5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just updated this while I was in there -- it's the latest action
## Documentation | ||
To see the latest documentation on `main`, visit https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone. | ||
|
||
To see the latest versioned-release's documentation, visit https://pkg.go.dev/github.com/pinecone-io/go-pinecone/pinecone. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This auto-resolves to the latest release
@@ -5,10 +5,15 @@ | |||
|
|||
# go-pinecone | |||
|
|||
[![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone) | |||
[![Go Reference](https://pkg.go.dev/badge/github.com/pinecone-io/go-pinecone.svg)](https://pkg.go.dev/github.com/pinecone-io/go-pinecone@main/pinecone) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@main
here points at the main
branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really appreciate the diligence here, thank you Audrey!
Problem
We tried a variety of different solutions for pushing static documentation to our GH pages site (see
sdk-docs
repo for more information), but the rendering was very bad.Related PRs:
Solution
main
vs the latest release-version's documentation.main
instead of latest versioned-release's documentation.Type of Change