microsoft / microsoft/aspire.dev

Measure documentation and UX funnel drop-off

Open
#1,582 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
193
Forks
87
Avg merge
1d 22h
Merged PRs (30d)
73

Description

## Problem

aspire.dev has general analytics, but it cannot show where readers abandon important content and UX journeys. Without ordered funnel stages, it is difficult to tell whether improvements are needed in discovery, documentation, commands, navigation, or recovery experiences.

## Proposed outcome

Add consent-gated funnel telemetry for these journeys:

- CLI installation
- Getting started / first app
- Search success
- Integration adoption
- Deployment intent
- Troubleshooting recovery
- 404 recovery
- Existing-app adoption

Each funnel should use a stable, versioned event contract with ordered stages and bounded dimensions. It must not collect raw search text, arbitrary URL queries, raw referrers, or a new user identity. Cross-page completion signals should use short-lived same-origin state.

For CLI installation, the reliable sequence ends at `command_copied`. Server-side script-request measurement is out of scope until StaticHost uses a compatible telemetry destination. Its existing Azure Monitor exporter is configured with the browser 1DS token, while Azure Monitor requires an Application Insights connection string.

## Acceptance criteria

- Funnel stages cover entry, meaningful progress, and completion or recovery outcomes that the current telemetry pipeline can reliably observe.
- Shared components and relevant English/Japanese guides emit consistent metadata.
- Search and 404 continuations correlate only same-origin destinations and expire promptly.
- Unknown 404 paths are reported through a fixed `/404/` sentinel.
- Automatic analytics do not leak query-bearing URLs or raw referrers.
- Unit, component, and browser tests cover the event contract and user journeys.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the current telemetry pipeline and the shared components and English/Japanese guides involved in the listed journeys. Review how consent, same-origin state, 404 handling, and the existing Azure Monitor exporter work before defining the event contract. Done means unit, component, and browser tests cover bounded funnel events without raw queries, referrers, or new user identity.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
analytics, documentation, testing, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.