docs: add usage-telemetry and rendered-pages reference pages#1833
docs: add usage-telemetry and rendered-pages reference pages#1833markmhendrickson wants to merge 1 commit into
Conversation
Add two reference pages surfaced as gaps by a partnership-hub doc-link audit: - /usage-telemetry: documents the usage_digest entity type — required fields (schema_version, period_start, period_end, reporter_channel), optional fields (aauth_sub optional for keyless guests, operation_counts, error_rate, error_counts, entity_type_usage, tool_usage, compliance_signals, friction_notes, effectiveness_signal, notes, redaction_salt), AAuth-grant vs keyless-guest submission paths, composite-key idempotency (reporter_channel+period_start+period_end), time-series retrieval with sort_by: snapshot.period_end, and the server-side PII redaction backstop on free-text fields. - /rendered-pages: documents publish_rendered_page — rendered_page entity fields (title, html_body, custom_css, meta_description), how the tool mints a guest_access_token, the /entities/<id>/html?access_token=<token> URL shape, that each call mints a fresh token (not stored in recoverable form), and how correct updates a live page without invalidating its URL. Each page is a triplet: .mdx (React/MDX), .md (markdown with frontmatter), and .meta.json. Both pages registered in: - docs/site/site_doc_manifest.yaml - frontend/src/site/seo_metadata.ts (ROUTE_METADATA) - frontend/src/components/MainApp.tsx (APP_ROUTES) Generated files regenerated by npm run prebuild:ui and included in commit. nav_order: 116 (usage-telemetry), 117 (rendered-pages). Closes #1832 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
review:pm
**[NON-BLOCKING] Documentation: unchecked test items — test plan marks three manual browsing/rendering checks as incomplete (manually browse routes, JSON example rendering, footer link resolution). These are reasonable post-deployment checks for doc PRs. Clarify if these are expected to run in a staging environment before production or if they are deferred to a follow-up. Holding them open is fine if immediate merge to production is scheduled; mention it in the PR comment to set expectations. 📎 Neotoma: neotoma#1832 |
|
review:ux User-facing surface & discoverability✓ Clear, navigable paths: Both pages are properly routed ( Interaction & task completion flowusage-telemetry page:
rendered-pages page:
Error & empty states
✓ usage-telemetry composite identity: The spec correctly calls out that a second Accessibility & clarity✓ Table formatting: Both pages use Markdown tables for field reference. Tables are screen-reader navigable and support keyboard navigation in the rendered site. Naming & discoverability from related surfaces✓ Related entity types are named clearly: The telemetry page mentions the relationship to Acceptance checklist
VerdictThis is a straightforward reference-page addition with no discoverability gaps or interaction friction. Happy-path flows are explicit, examples are real, and naming is clear. The one minor note about deleted-entity behavior for rendered pages is a future clarification, not a blocker. SIGNED_OFF — Ready to merge from UX lens. 📎 Neotoma: markmhendrickson/neotoma#1833 |
|
review:qa APPROVE Summary This PR adds reference documentation pages for two existing, pre-shipped features: the Functional Surface The PR modifies only:
These are non-functional changes — they expose existing, already-tested features through documentation, not new behavior. Test Coverage Assessment The underlying features have pre-existing test coverage:
No new branches, endpoints, or agent-observable behavior introduced in this PR. Verdict No functional surface — no eval required. This is a pure documentation addition. The referenced features ( |
|
review:content Content reviewBoth reference pages are shippable. They dogfood the features directly (JSON examples for usage_digest submission and retrieval, full publish_rendered_page workflow with token lifecycle), maintain builder-to-builder voice (no marketing filler), and prioritize specificity over abstraction (actual PII patterns, composite-key idempotency rules, the intentional optionality of aauth_sub). Strengths
Forward-looking work (not blocking)These pages are reference-focused. A follow-on opportunity: a dogfooding narrative that ties both features together and positions them relative to the observability / partnership story. (The features themselves are here and shipable; the story of why they matter together is a separate content piece. I will file a task for this.) The pages unlock downstream use of publish_rendered_page for build-in-public reports and agent-generated summaries, which is a natural fit for Corvus content pipeline. 📎 Neotoma: Issue #1832 |
|
🤖 Vanellus — Ateles swarm, PR steward Aggregated Review VerdictPer-Lens Roll-up[PM — Pavo] APPROVE ✓
[UX — Accipiter] SIGNED_OFF ✓
[QA — Phoenicurus] APPROVE ✓
[Content — Corvus] COMMENT ✓
Blocking FindingsNone. No [BLOCKING] items from any lens. CI StatusRequired: — SUCCESS ✓ Head commit: ab38dda Gate Inheritance CheckParent issue #1832 — retrieving gate_status… Merge RecommendationAll lenses clear. Ready for merge. Gate inheritance check in progress; will file checkpoint_brief if any pre-impl gates are pending. Operator approval required per autonomy guardrail. 📎 Neotoma: neotoma#1832 · neotoma#1833 |
Docs previewPreview URL: https://dev.neotoma.io/pr-1833/ Built from |
Summary
/usage-telemetry— new reference page for theusage_digestentity type: required fields (schema_version,period_start,period_end,reporter_channel), optional fields includingaauth_sub(intentionally optional so keyless guests can submit without an AAuth keypair),operation_counts,error_rate,error_counts,entity_type_usage,tool_usage,compliance_signals,friction_notes,effectiveness_signal,notes, andredaction_salt; AAuth-grant vs keyless-guest submission; composite-key idempotency (reporter_channel+period_start+period_end); time-series retrieval viasort_by: "snapshot.period_end"; server-side PII redaction backstop on free-text fields./rendered-pages— new reference page forpublish_rendered_page:rendered_pageentity fields (title,html_body,custom_css,meta_description), guest access token minting, the/entities/<id>/html?access_token=<token>URL shape, per-call token freshness (raw tokens not stored in recoverable form), inline-create with idempotency key, and howcorrectupdates a live page without invalidating its share URL.What changed
Each page is a triplet:
.mdx(React/MDX with footer),.md(markdown with YAML frontmatter),.meta.json. Pages registered in:docs/site/site_doc_manifest.yamlfrontend/src/site/seo_metadata.ts(ROUTE_METADATA)frontend/src/components/MainApp.tsx(APP_ROUTES)Generated files under
docs/site/generated/regenerated bynpm run prebuild:uiand included in the commit (baseline-checked in CI).nav_ordervalues: 116 (usage-telemetry), 117 (rendered-pages) — verified against current max of 115.Test plan
npm run prebuild:uipasses with✓ MDX site page metadata validation passed./usage-telemetryand/rendered-pageson the deployed site/changelogand related pagesCloses #1832
🤖 Generated with Claude Code