Skip to content

docs(ai): add missing description frontmatter across docs pages #12

@felixwidjaja

Description

@felixwidjaja

Background

From the AI readiness audit (April 20, 2026). 31 of 38 crawled docs URLs have no description frontmatter. Descriptions serve double duty: search result snippets and llms.txt page summary entries used by AI agents.

Scope

Section Pages missing descriptions
/cli/* 14 of 16
/platform/* 5 of 6
/datumctl/* 3 of 3
/domain-dns/* 2 of 2
/galactic-vpc/* 1 of 2
/ai-edge/* 1 of 1
/connectors/* 1 of 1
/datum-mcp, /desktop-apps, /get-involved, /overview 4 of 4

Only 7 pages currently have descriptions: galactic-vpc/overview, cli/datumctl_activity, cli/datumctl_diff, features, kubernetes, platform/metrics-export, and platform/setup.

Priority order

  • /ai-edge/overview — core product page
  • /connectors/tunnels — key feature
  • /datum-mcp — high-value AI-relevant page
  • /datumctl/overview, /datumctl/authentication — CLI entry points
  • All /platform/* sub-pages
  • All /domain-dns/* pages
  • Remaining /cli/* pages (bulk fill)

Fix

In each .mdx file, add to frontmatter:

description: "1–2 sentences specific enough that an AI can answer 'what does this page cover?' without fetching full content."

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions