search

okta / okta-sdk-golang

A Golang SDK for interacting with the Okta management API, enabling server-side code to manage Okta users, groups, applications, and more.
https://github.com/okta/okta-sdk-golang
Other
173 stars 143 forks source link

publish v3 generated docs #413

Closed monde closed 9 months ago

monde commented 9 months ago

Describe the feature request?

We should be publishing the markdown generated SDK docs that are produced during v3 code gen. I'm not sure of the best way to hack this into GH. Perhaps in a dist/ directory in the repo, or the default wiki each GH repo comes with.

New or Affected Resource(s)

new docs

Provide a documentation link

No response

Additional Information?

No response

tgoodsell-tempus commented 9 months ago

@monde You may also want to checkout the "publish" patterns for the go docs when doing a module publish. You probably can just funnel all that stuff into https://pkg.go.dev/github.com/okta/okta-sdk-golang/v3/okta#readme-overview and have it be the display page for you.

monde commented 9 months ago

Never mind, as @tgoodsell-tempus points, we are already getting this for free in go package distribution https://pkg.go.dev/github.com/okta/okta-sdk-golang/v3/okta