-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Revise the Universal Gateway Overview page #1647
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
base: main
Are you sure you want to change the base?
Conversation
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 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
universal-gateway/overview.mdx
Outdated
| 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. |
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.
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 ofdefinition-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
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.
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.
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.
More light feedback
fresh PR so Mintlify will deploy a preview