Skip to content

docs: navigation redesign — product-first IA with solutions and templates#75

Merged
dhruvja merged 9 commits into
dhruvja/docs/ephemeral-spl-tokenfrom
dhruvja/docs/navigation-restructure
Jul 22, 2026
Merged

docs: navigation redesign — product-first IA with solutions and templates#75
dhruvja merged 9 commits into
dhruvja/docs/ephemeral-spl-tokenfrom
dhruvja/docs/navigation-restructure

Conversation

@dhruvja

@dhruvja dhruvja commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Restructures the docs navigation into a 4-tab product-first IA (Get Started / Products / Guides / Integrations) with a solutions layer, new guides and app templates, a navbar product indicator, and link/redirect hygiene — stacked on #71.

Testing:

  • npm run validate

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1080e13c-6689-4e43-9940-c1c1ed8b7a85

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dhruvja/docs/navigation-restructure

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@dhruvja
dhruvja changed the base branch from dhruvja/docs/ephemeral-spl-token to main July 14, 2026 11:31
@dhruvja

dhruvja commented Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Temporarily targeting main to trigger the Mintlify preview deployment — this PR is stacked on #71 (dhruvja/docs/ephemeral-spl-token) and will be retargeted back once the preview is up / #71 merges. The diff currently includes #71's commits; review only the navigation-redesign delta here.

@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
magicblock-42 🟢 Ready View Preview Jul 14, 2026, 11:36 AM

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

@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
magicblock-42 🟡 Building Jul 14, 2026, 11:34 AM

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

@jonasXchen

Copy link
Copy Markdown
Collaborator

The simplification of the navigation looks great!

A few suggestions to improve the current state of docs:

  • Harmonized product page: Every product should have a similar structure with Quickstart, Concepts, API Reference for easier and faster navigation. Wonder whether Examples is better Guides, also this would align with our existing example repo where the guides are pointing to?
  • A few, clear, consistent, and distinctive wording: In the navigation we have Examples, after clicking we have Templates, but we also have Use Cases. For these Advanced Examples, we could call it Boilerplates?
  • Brand elevation through visual contrast: For every Use Case and Boilerplate, we should have some visuals that improves docs readability. We don't target for developers to fully read the docs, most of them will look into sections, and the sections should give an woow effect, it is so clear and easy to understand, rather than text overload.

@dhruvja

dhruvja commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the suggestions, they seem valid

  • Yes having consistency across different products would be better but we should omit the sections for the products that doesnt have any content like oracle and vrf dont have API. Guide is still a better name since we are giving them instructions on how to build it.
  • I think this is the naming convention we should follow
    • Use Cases: problems and industries
    • Solutions: multi product architecture
    • Guides: task oriented instructions
    • Examples: runnable reference implementations
    • Templates: forkable applications with a working client side
  • Yes totally agree.

@jonasXchen

Copy link
Copy Markdown
Collaborator

Thanks for the suggestions, they seem valid

  • Yes having consistency across different products would be better but we should omit the sections for the products that doesnt have any content like oracle and vrf dont have API. Guide is still a better name since we are giving them instructions on how to build it.

  • I think this is the naming convention we should follow

    • Use Cases: problems and industries
    • Solutions: multi product architecture
    • Guides: task oriented instructions
    • Examples: runnable reference implementations
    • Templates: forkable applications with a working client side
  • Yes totally agree.

Sounds good, possible if we can simplify naming conventions for the titles/subtitles, by reducing them to 3, perhaps combining examples and guides -> guides? and solutions and templates -> Solutions?

@dhruvja

dhruvja commented Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

i think examples and guides can be combined into guides but solutions and templates are a bit different so i wouldnt combine them. Templates are boiler plate code they can use to build on top but solutions would be on how they can start building and the things they need to look for when they go to production.

@dhruvja
dhruvja changed the base branch from main to dhruvja/docs/ephemeral-spl-token July 22, 2026 19:22
@dhruvja
dhruvja marked this pull request as ready for review July 22, 2026 19:24
@dhruvja
dhruvja merged commit 9b4fa8d into dhruvja/docs/ephemeral-spl-token Jul 22, 2026
1 check passed
@dhruvja
dhruvja deleted the dhruvja/docs/navigation-restructure branch July 22, 2026 19:24
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.

2 participants