Skip to content

Restructure top-level IA around products and a shared Platform tab - #2270

Open
sg-writer wants to merge 1 commit into
mainfrom
new-highlevel-ia
Open

Restructure top-level IA around products and a shared Platform tab#2270
sg-writer wants to merge 1 commit into
mainfrom
new-highlevel-ia

Conversation

@sg-writer

Copy link
Copy Markdown
Contributor

Summary

Restructures the top-level information architecture so products and shared platform features are no longer conflated under a single "Gateway" tab.

Navigation

  • New Platform tab owns the shared primitives: Endpoints (agent + cloud unified), Traffic Policy, Domains & TLS, Identity & Access, Observability, ngrok Agent, and Kubernetes Operator.
  • Gateway slimmed to the product: overview, examples, and the use-case guides (API Gateway, Device Gateway, Site-to-Site, Webhooks-to-On-Prem, Security) moved in from Guides.
  • Integrations promoted to its own top-level tab; Changelogs folded into Reference.
  • Guides tab dissolved (/guides/start).
  • Duplicate nav wirings reduced 33 → 1; merge orphans resolved.

Tab order: Start · Platform · Gateway · AI Gateway · Share Localhost · Integrations · Reference · Pricing · About

Slugs & redirects (URL-stable)

  • gateway/ endpoint pages → endpoints/, gateway/ domain+TLS pages → domains/, guides/ use-cases → gateway/ (85 pages).
  • Redirects added for every moved slug; 574 internal links swept across 173 files; section img/ dirs moved with their pages.

Cleanup

  • Fixed pre-existing broken links (images, relative paths, a dead anchor) and Vale errors surfaced during QA.
  • Excluded .skills/ from the docs build.

Verification

  • mint broken-links: no broken links found
  • Vale: 0 errors (3 advisory first-person CTA warnings intentionally left)
  • All 757 nav pages resolve to files; no nav page references a moved slug.

Scope / notes

  • This is an IA + slug/redirect change — no content rewrites. Hub/overview page rewrites and use-case re-titling are planned as a follow-up (Phase 4) on a separate branch.
  • Pre-existing unrelated note: mint dev fails a contextual.options schema check on main (config lists AI-assistant options newer than the pinned mint); untouched here and worth a separate fix.

Rework the site navigation so products and shared platform features are no
longer conflated under "Gateway".

Navigation (docs.json):
- Add a Platform tab owning the shared primitives: Endpoints (agent + cloud
  unified), Traffic Policy, Domains & TLS, Identity & Access, Observability,
  ngrok Agent, and Kubernetes Operator.
- Slim Gateway to the product itself: overview, examples, and the use-case
  guides (API Gateway, Device Gateway, Site-to-Site, Webhooks-to-On-Prem,
  Security) moved in from Guides.
- Promote Integrations to its own top-level tab; fold Changelogs into Reference.
- Dissolve the Guides tab; redirect /guides to /start.
- De-duplicate nav wirings (33 down to 1) and resolve merge orphans.

Slugs and redirects (URL-stable):
- Move gateway/ endpoint pages to endpoints/, gateway/ domain+TLS pages to
  domains/, and guides/ use-cases to gateway/ (85 pages).
- Add redirects for every moved slug; sweep 574 internal links across 173 files.
- Move section img/ directories alongside their pages.

Cleanup:
- Fix pre-existing broken links (images, relative paths, dead anchors) and
  Vale errors surfaced by the checks; exclude .skills/ from the docs build.
@sg-writer sg-writer added kind/enhancement New feature or improvement to the docs experience docs/ia Concerning the information architecture of the docs. labels Jul 30, 2026
Comment thread domains/tcp-addresses.mdx

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[StyleRules.FirstPerson] Avoid first-person pronouns such as 'us'—speak to 'you' the reader instead.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[StyleRules.FirstPerson] Avoid first-person pronouns such as 'our'—speak to 'you' the reader instead.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[StyleRules.FirstPerson] Avoid first-person pronouns such as 'us'—speak to 'you' the reader instead.

@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ngrok 🟢 Ready View Preview Jul 30, 2026, 8:22 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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

Labels

docs/ia Concerning the information architecture of the docs. kind/enhancement New feature or improvement to the docs experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant