Skip to content

Restructure Universal Gateway #1224

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

Open
wants to merge 148 commits into
base: main
Choose a base branch
from

Conversation

S3Prototype
Copy link
Collaborator

@S3Prototype S3Prototype commented Mar 13, 2025

Restructures the Universal Gateway to make it fit our new question-answer approach and make it more modular.

Preview here

How to review

We're looking for thoughts on:

  • The naming of the pages
    • Thought starters:
      • How does the question form of the titles in the sidebar look?
      • Some of the pages aren't titled as questions. Do you have a preference?
      • Do you think it makes sense to have some be questions and some not be questions?
  • The structure of the pages
    • Thought starters:
      • Do the pages feel the right length? Too short? Too long?
      • Do they feel like they address the questions they're built around?

Copy link

vercel bot commented Mar 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ngrok-docs ✅ Ready (Inspect) Visit Preview May 8, 2025 2:59pm

@S3Prototype S3Prototype changed the title Restructure Universal Gateway > Concepts > Domains Restructure Universal Gateway > Concepts Mar 14, 2025
S3Prototype added a commit that referenced this pull request May 14, 2025
…estructure (#1337)

I decided to take the tabs and code blocks updates in #1224 and merge
them separately into main so we can have them.

This PR:

- Replaces the docusaurus `Tabs` component with mantle tabs, which means
the entire docs site no longer uses the old docusaurus style tabs
anymore. ([Preview
here](https://ngrok-docs-git-shaquil-doc-266-copy-over-tabs-554909-ngrok-dev.vercel.app/docs/traffic-policy/actions/add-headers/#example-traffic-policy-document))


https://github.com/user-attachments/assets/1fb66470-24e2-4df7-92d1-bc1cd3a29ee1

- Adds the language tab to singular code block components ([Preview
here](https://ngrok-docs-git-shaquil-doc-266-copy-over-tabs-554909-ngrok-dev.vercel.app/docs/agent/ssh-reverse-tunnel-agent/#custom-domain))
<img width="731" alt="image"
src="https://github.com/user-attachments/assets/20c95908-a192-4a2b-8b45-374d7b51a252"
/>


- Adds the book icon with links to the SDK docs ([Preview
here](https://ngrok-docs-git-shaquil-doc-266-copy-over-tabs-554909-ngrok-dev.vercel.app/docs/agent/agent-tls-termination#step-4--start-your-upstream-server))


https://github.com/user-attachments/assets/57cf3b6b-550d-4d56-a7cd-36dd0fb353dc


## This PR also

Prevents the ConfigExample component from showing the Agent Config
variant by default. Now it only shows the Traffic Policy version by
default

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
@sg-writer sg-writer added docs/content Changes to the written material in the docs kind/enhancement New feature or improvement to the docs experience area/universal-gateway kind/prose-debt Refactoring content style, structure, or formatting (think: tech debt for docs) docs/infra Changes to the infrastructure of the docs site and removed kind/enhancement New feature or improvement to the docs experience labels May 29, 2025
@S3Prototype S3Prototype changed the title Restructure Universal Gateway > Concepts Restructure Universal Gateway Jun 5, 2025
@sg-writer sg-writer self-requested a review June 5, 2025 18:15
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 docs/infra Changes to the infrastructure of the docs site kind/enhancement New feature or improvement to the docs experience 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