Skip to content

Docs: Auto-generated documentation update#2121

Open
ngrok-docs-bot[bot] wants to merge 1 commit intomainfrom
ngrokrock/dev-gen-changes
Open

Docs: Auto-generated documentation update#2121
ngrok-docs-bot[bot] wants to merge 1 commit intomainfrom
ngrokrock/dev-gen-changes

Conversation

@ngrok-docs-bot
Copy link
Copy Markdown
Contributor

This PR contains automatically generated documentation changes from the ngrok monorepo.

Copy link
Copy Markdown
Contributor

@sg-writer sg-writer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'll need to update this text in the generated docs to prevent these changes from being overridden. I'll open a PR over there. cc @BPKelley

@BPKelley
Copy link
Copy Markdown
Contributor

we'll need to update this text in the generated docs to prevent these changes from being overridden. I'll open a PR over there. cc @BPKelley

@sg-writer So I think you're referring to updating the OpenAPI spec? I've got another PR where I'm attempting to do that, I'd love your quick review there: https://github.com/ngrok-private/ngrok/pull/42934

The approach is basically:

That's good enough for me, UX-wise. I don't need a big yellow in-page banner liked I coded up in this PR (that was before I knew to update the spec instead of the generated pages) -- literally it just needs to say the word "Deprecated" somewhere in the page, so the human or AI agent knows not to use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants