Skip to content

docs: split API Docs features, More menu, Mock Servers placeholder - #169

Closed
anthonyd-bruno wants to merge 1 commit into
usebruno:docs/restructure-by-productfrom
anthonyd-bruno:docs/api-docs-split-more-menu
Closed

docs: split API Docs features, More menu, Mock Servers placeholder#169
anthonyd-bruno wants to merge 1 commit into
usebruno:docs/restructure-by-productfrom
anthonyd-bruno:docs/api-docs-split-more-menu

Conversation

@anthonyd-bruno

Copy link
Copy Markdown
Collaborator

Note

Stacked on #163 — this PR targets docs/restructure-by-product, not main, so it shows only the new work. If #163 merges first, GitHub will retarget it to main automatically.

What this does

1. Separates writing docs from generated HTML docs (API Docs tab)

Feedback was that the in-app markdown docs and the auto-generated HTML docs read as one confusing feature. The tab now has two clearly-named groups:

  • Write Docs in Bruno — the four authoring pages (workspace/collection/folder/request), paths unchanged
  • Generate HTML Docs — new html-docs/ section split from api-docs/auto-generate-docs at its existing headings: Overview, Generate Docs, Environments, Search, Interactive Playground, Deploy & Share

The tab overview is rewritten as a two-feature router (card comparison + how the features connect). /api-docs/auto-generate-docs gets a permanent redirect to /html-docs/overview, which also covers the absolute link from the v3 overview.

2. Collapses Reference + Licensing into a "More" navbar menu

Clicking More opens a dropdown with the two sections (with descriptions) plus a curated list of popular pages: JavaScript API Reference, Postman Migration, Environment Variables, OAuth 2.0. Popular links use single-page pages entries — the schema's item+href variant is broken in the renderer (drops the href, lands on the default page).

3. Adds a Mock Servers tab as a structural placeholder

One coming-soon overview page under mock-servers/, slotted between API Docs and VS Code Extension. Note: this is publicly visible once deployed — hold this if the release shouldn't be signaled yet (or we can add noindex).

4. Fixes silently-blank icons

Mintlify resolves icon names against Font Awesome, not Lucide, and mint validate doesn't catch invalid names — they just render as empty space. Fixed bracesbrackets-curly, arrow-right-leftright-left, layerslayer-group, and the API Client tab's app-windowbrowser (blank since #163).

Verification

  • mint validate passes; mint broken-links reports the same pre-existing set as the base branch, none new
  • All redirects preserved; only new URL scheme is html-docs/* (redirected from the old page)
  • Menu navigation and icon rendering verified by clicking through the rendered site in a headless browser (every menu item lands on its page; every tab/menu icon renders a visible SVG; every icon name returns 200 from Mintlify's Font Awesome CDN)

🤖 Generated with Claude Code

Builds on the product-based navigation restructure (usebruno#163).

- Separate writing docs in the app from the generated-HTML-docs
  feature, which shared one "Create Documentation" group and read as a
  single feature. The API Docs tab now has "Write Docs in Bruno"
  (workspace/collection/folder/request) and "Generate HTML Docs" (new
  html-docs/ pages split from api-docs/auto-generate-docs at its
  existing headings: overview, generate, environments, search,
  playground, deploy). The tab overview is rewritten as a two-feature
  router page. /api-docs/auto-generate-docs redirects to
  /html-docs/overview; the four writing pages keep their paths.

- Collapse the Reference and Licensing tabs into a "More" tab that
  opens a navbar menu, and append a curated list of popular pages
  (JavaScript reference, Postman migration, environment variables,
  OAuth 2.0). The popular links use single-page `pages` entries
  because the schema's item+href variant drops the href on click and
  lands on the site's default page.

- Add a Mock Servers tab as a structural placeholder for the upcoming
  release, with a single coming-soon overview page.

- Fix icon names that silently rendered blank: Mintlify resolves
  icons against Font Awesome, not Lucide, and mint validate does not
  catch bad names. braces/arrow-right-left/layers become
  brackets-curly/right-left/layer-group, and the API Client tab's
  app-window (blank since the restructure) becomes browser.

mint validate passes; mint broken-links reports no new breaks. Menu
navigation and icon rendering verified in a headless browser.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@anthonyd-bruno

Copy link
Copy Markdown
Collaborator Author

Superseded by #170 — same changes, but with the head branch pushed to usebruno so the Mintlify preview deployment can build (the bot doesn't run on fork branches).

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.

1 participant