docs: split API Docs features, More menu, Mock Servers placeholder - #169
Closed
anthonyd-bruno wants to merge 1 commit into
Closed
Conversation
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>
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Stacked on #163 — this PR targets
docs/restructure-by-product, notmain, so it shows only the new work. If #163 merges first, GitHub will retarget it tomainautomatically.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:
html-docs/section split fromapi-docs/auto-generate-docsat its existing headings: Overview, Generate Docs, Environments, Search, Interactive Playground, Deploy & ShareThe tab overview is rewritten as a two-feature router (card comparison + how the features connect).
/api-docs/auto-generate-docsgets 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
pagesentries — the schema'sitem+hrefvariant 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 addnoindex).4. Fixes silently-blank icons
Mintlify resolves icon names against Font Awesome, not Lucide, and
mint validatedoesn't catch invalid names — they just render as empty space. Fixedbraces→brackets-curly,arrow-right-left→right-left,layers→layer-group, and the API Client tab'sapp-window→browser(blank since #163).Verification
mint validatepasses;mint broken-linksreports the same pre-existing set as the base branch, none newhtml-docs/*(redirected from the old page)🤖 Generated with Claude Code