Skip to content

Conversation

@sg-writer
Copy link
Contributor

fresh PR so Mintlify will deploy a preview

@sg-writer sg-writer added docs/content Changes to the written material in the docs area/universal-gateway kind/prose-debt Refactoring content style, structure, or formatting (think: tech debt for docs) labels Oct 21, 2025
Copy link
Collaborator

@S3Prototype S3Prototype left a comment

Choose a reason for hiding this comment

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

This a big improvement! I left some comments for discussion. I also think we need Niji or Alan to give final sign-off on pages like this

description: Learn about ngrok's suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity.
---

ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity.
Copy link
Collaborator

Choose a reason for hiding this comment

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

device gateways, identity-aware proxies, and site-to-site connectivity
How would you feel about adding all 3 of these terms to the definition wrapper? You'd have to add it to the array at the top of definition-wrapper.js (it's set up that way due to mintlify limitations)

My reasoning: It feels like if you don't already know what those are, we've lost you.

Also, it may be worth incorporating some of your explanation of what makes it universal in this opening paragraph.

Something like

ngrok's Universal Gateway is a suite of tools that secure, accelerate, and protect your applications wherever they're running. The Universal gateway empowers you to build API and device gateways, identity-aware proxies, site-to-site connectivity, and more.

That's a little rough, but the vision is that the opening would lead with more universally comprehensible concepts before getting technical and specific. This is definitely a conversation-starter comment rather than a specifically requested change, so I'm curious your thoughts

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good call - we should get in the habit of adding to the definition list anytime we're editing a piece that includes undefined niche terms.

Copy link
Collaborator

@S3Prototype S3Prototype left a comment

Choose a reason for hiding this comment

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

More light feedback

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

Labels

area/universal-gateway docs/content Changes to the written material in the docs kind/prose-debt Refactoring content style, structure, or formatting (think: tech debt for docs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants