docs: improve IA for developers — surface quickstart in Get Started#1193
Open
ekline[bot] wants to merge 1 commit intomainfrom
Open
docs: improve IA for developers — surface quickstart in Get Started#1193ekline[bot] wants to merge 1 commit intomainfrom
ekline[bot] wants to merge 1 commit intomainfrom
Conversation
…findability The "For Developers" sub-category buried the developer quickstart as the 4th item in Get Started, behind platform installation content. Developers — the most common persona — had to scan past irrelevant platform engineer content to find their entry point. This change promotes the three developer pages (Quickstart, CLI and Dashboard, Advanced Commands) to top-level items directly after "Install Okteto CLI", creating a natural flow: install CLI → quickstart → go deeper. Platform installation and app deployment content remains but moves below the developer path. Also updates pagination_prev in dev-quickstart to reflect the new order.
ekline
Bot
requested review from
codyjlandstrom,
ifbyol,
pchico83 and
rlamana
as code owners
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Summary
A persona-based information architecture review identified that the Developer persona — the most common docs visitor — had poor findability in the "Get Started" section. The developer quickstart was buried as the 4th sub-item inside a "For Developers" sub-category, behind platform installation content that isn't relevant to developers.
This PR promotes developer content to the top of the "Get Started" sidebar, creating a natural onboarding flow: Install CLI → Quickstart → CLI and Dashboard → Advanced Commands.
Persona context
Developer: A software engineer whose platform team has already set up Okteto. They want to deploy dev environments, write code with hot reload, and get fast feedback. They know their stack but are new to Okteto.
Top 3 findings from IA review
sidebars.jssrc/content/index.mdsidebars.jsWhat this PR fixes
Finding #1: Restructured the "Get Started" sidebar to eliminate the "For Developers" sub-category. The three developer pages (Quickstart, Using CLI and Dashboard, Advanced Commands) are now top-level items directly after "Install Okteto CLI". Platform installation and app deployment content remains but is positioned after the developer path.
Changes:
sidebars.js— Reordered Get Started items; removed "For Developers" wrapper categorysrc/content/get-started/dev-quickstart.mdx— Updatedpagination_prevto point toinstall-okteto-cli(wasinstall/index)Before:
After:
Remaining items
npm link#2: Add persona-based routing to the landing page (index.md)How to verify
npm startin thedocs/directory)