Skip to content

Improve aspire.dev search discoverability and agent-readable content #1624

Description

Summary

Aspire's observability story is stronger than the site's search presentation suggests. Make Aspire easier to discover through problems developers are trying to solve: viewing OpenTelemetry data locally, debugging across services, and giving coding agents access to application logs, traces, and resource health.

Verified findings

Repeated meta descriptions

The homepage and representative documentation pages render the same generic <meta name="description">, including:

  • /dashboard/overview/
  • /dashboard/standalone/
  • /get-started/ai-coding-agents/
  • /get-started/aspire-mcp-server/
  • /fundamentals/telemetry/
  • /app-host/migrate-from-docker-compose/

Their JSON-LD already contains page-specific descriptions. Investigate the metadata pipeline, particularly the global description emitted by src/frontend/config/head.attrs.ts, and ensure rendered HTML uses each page's frontmatter description.

Homepage Markdown is missing the content

https://aspire.dev/index.md currently returns only:

# Aspire

<HomePage />

The Markdown representation should contain meaningful, agent-readable content equivalent to the rendered homepage, including the product explanation, observability capabilities, and getting-started links.

Observability needs more explicit search positioning

Improve titles, descriptions, introductions, headings, and internal links around:

  • Local development observability
  • OpenTelemetry dashboard / OTLP viewer
  • Distributed tracing across local services
  • Application logs and traces for coding agents
  • Python and JavaScript observability
  • Aspire and Docker Compose comparisons

Start with the existing dashboard, telemetry, and agent documentation. Add practical examples showing a human and a coding agent investigating the same application failure.

Be precise about “agent observability”: this issue means application observability for developers and coding agents, not monitoring an AI agent's behavior, cost, or performance.

Locale metadata and fallback behavior

Review untranslated locale handling for /da/ and /uk/. These pages currently return 200 responses, use self-referencing canonicals, emit language alternates, and appear in the sitemap. Verify whether shared or untranslated content is being served and ensure canonical and language annotations accurately reflect the actual content.

Homepage payload

The homepage response is approximately 701 KB uncompressed. Its generated HTML contains many code examples and inactive AppHost variants. Measure the AppHost builder contribution separately with a reproducible method, then investigate rendering inactive examples only when selected. This is a payload observation, not a measured Core Web Vitals failure.

Proposed work

  • Fix page-specific meta description rendering.
  • Add meaningful homepage Markdown content.
  • Make observability explicit in relevant page titles, descriptions, and headings.
  • Improve links between the homepage, dashboard, telemetry, and agent guides.
  • Add or expand practical examples showing humans and agents investigating the same application failure.
  • Review canonical and language handling for untranslated pages.
  • Measure homepage performance and reduce unnecessary initial example markup.
  • Establish a Search Console baseline for branded and non-branded queries.

Validation

  • Check generated HTML and Markdown, not only source frontmatter.
  • Verify descriptions remain page-specific across representative pages.
  • Verify the homepage Markdown contains useful product and navigation content.
  • Verify canonical and hreflang values against the content actually served for each locale.
  • Use Search Console after recrawling to evaluate impressions, clicks, CTR, and query/page performance.

The current review does not establish search volumes, Google ranking positions, or traffic impact.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

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