Skip to content

docs(ia): rewrite Core Concepts landing page for inline navigation#1241

Open
ekline[bot] wants to merge 1 commit into
mainfrom
docs/ia/fix-core-concepts-landing
Open

docs(ia): rewrite Core Concepts landing page for inline navigation#1241
ekline[bot] wants to merge 1 commit into
mainfrom
docs/ia/fix-core-concepts-landing

Conversation

@ekline
Copy link
Copy Markdown
Contributor

@ekline ekline Bot commented May 7, 2026

Summary

A persona-scoped IA review identified the Core Concepts landing page (src/content/core/index.mdx) as the highest-impact fix across all three user personas (developer, platform engineer, AI/agent practitioner). Every persona passes through this page to understand Okteto's building blocks.

Issues fixed:

  • Removed banned preamble opening ("Before you start building with Okteto, it helps to understand...")
  • Replaced 10 standalone "Learn more about X →" links with inline descriptive sentences
  • Fixed frontmatter description to be a single functional sentence (not marketing copy)
  • Applied correct Okteto terminology and capitalization throughout (Namespaces, Development Environments, Personal Access Tokens, Admin/Developer roles, etc.)

Persona context

Persona Goal How this page serves them
Developer Understand Okteto concepts before building Conceptual hub — first stop after quickstart
Platform Engineer Learn the platform architecture Reference map for all core features
AI/Agent Practitioner Understand environment model Foundation for agent workflow setup

Top 3 IA findings from persona review

Rank Priority Persona Issue Affected area Proposed fix
1 High All Core Concepts landing page uses banned preamble and 10 "Learn more →" links core/index.mdx This PR — rewrite with inline links
2 High Platform Engineer Admin landing page uses marketing language and "Learn more →" links admin/index.mdx Follow-up PR
3 Medium Developer Developer quickstart buried 3 levels deep in sidebar Sidebar nav Follow-up PR

What this PR fixes

Finding #1: the Core Concepts landing page. The rewrite:

  • Opens with "Okteto organizes development around a set of building blocks..." (subject + what it does)
  • Embeds every link inline in a sentence that describes the target page
  • Removes all arrow-style standalone links
  • Preserves all original link targets — no links added or removed

Remaining items

How to verify

  1. Open the Core Concepts page in the docs site
  2. Confirm every concept links to its detail page inline (no standalone "Learn more" lines)
  3. Confirm the page opens with the subject, not a preamble
  4. Run yarn build to validate no broken links

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

Replace banned preamble ("Before you start building with Okteto...") and
10 standalone "Learn more →" links with inline descriptive sentences.
All three personas (developer, platform engineer, AI practitioner) pass
through this hub page — the rewrite makes every concept scannable and
linkable in flowing text.

Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit 056f473
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/69fcd5073e5e9d0008e3302f
😎 Deploy Preview https://deploy-preview-1241--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

0 participants