Skip to content

docs: move net diagnostics integration into the tutorial#78

Merged
okdistribute merged 1 commit into
mainfrom
rae/net-diagnostics-clienthost
Jun 24, 2026
Merged

docs: move net diagnostics integration into the tutorial#78
okdistribute merged 1 commit into
mainfrom
rae/net-diagnostics-clienthost

Conversation

@okdistribute

@okdistribute okdistribute commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Reorganizes the net diagnostics docs so the integration code lives in the "Diagnose a connectivity issue" tutorial, where readers are already working, instead of on a separate page a click away.

  • quickstart.mdx (tutorial): the "Integrate into your app" section now carries the actual code — cargo add, the client setup with the capability grant, and registering ClientHost on an existing router (with the note that .accept(CLIENT_HOST_ALPN, ...) must come before .spawn()).
  • usage.mdx (Network Diagnostics): becomes a reference for reading reports and troubleshooting. It keeps "Understanding Reports" and gains a troubleshooting entry for the case where the grant is present and the endpoint is online but the report never arrives, because nothing accepts CLIENT_HOST_ALPN.

No nav or redirect changes; both pages stay where they are and cross-link.

Granting NetDiagnosticsCap::GetAny only authorizes the platform to dial
back; the endpoint must also accept CLIENT_HOST_ALPN to answer. Explain
registering ClientHost on an existing router before .spawn(), and add a
troubleshooting entry for when the grant is present but the report never
arrives.
@mintlify

mintlify Bot commented Jun 24, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
number0 🟢 Ready View Preview Jun 24, 2026, 6:22 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@okdistribute okdistribute merged commit 469d5fe into main Jun 24, 2026
3 checks passed
@okdistribute okdistribute changed the title docs: ClientHost setup and troubleshooting for net diagnostics docs: move net diagnostics integration into the tutorial Jun 24, 2026
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.

1 participant