Skip to content

Implement Graphite related docs links - #778

Draft
juandolealt wants to merge 1 commit into
mainfrom
agent/implement-graphite-doc-links
Draft

Implement Graphite related docs links#778
juandolealt wants to merge 1 commit into
mainfrom
agent/implement-graphite-doc-links

Conversation

@juandolealt

Copy link
Copy Markdown
Member

Summary

  • Implement the Graphite Docs to Docs endpoint in the repository that owns the developer-docs HTML.
  • Generate a related-links manifest at build time for authored MDX pages and sitemap-only generated OpenAPI pages.
  • Render route-specific related documentation cards as normal anchors in static HTML.
  • Update the links correctly during Waku client-side navigation.

Implementation

  • Call Graphite with canonical https://tempo.xyz/developers/docs/... source URLs.
  • Keep validated related and random results, while rejecting external, non-docs, malformed, self, and duplicate targets.
  • Discover 194 local docs files and supplement them with the production sitemap so generated docs routes are covered.
  • Pace requests below Graphite's limit, cap response size, use a four-second timeout, and stop after three consecutive retryable failures.
  • Cache a complete manifest for 24 hours, preserve stale route data during partial outages, and advance the cache timestamp only after a complete refresh.

Graphite contract: https://docs.graphite.io/docs/standard-internal-links-api-documentation

Validation

  • pnpm biome check on changed files
  • VITE_USE_HTTP=true pnpm check:types
  • VITE_USE_HTTP=true pnpm test: 22 files and 327 tests passed
  • CI=true VITE_USE_HTTP=true pnpm build: 467 files generated
  • Confirmed 221 routes and 1,768 related links in the generated manifest.
  • Confirmed eight route-specific anchors in static HTML for authored docs and generated OpenAPI pages.
  • Confirmed the related set updates after Waku client-side navigation.
  • Completed desktop and mobile visual QA.

Operational note

Recommendations refresh at build time. The current full route manifest is about 40 KB gzip and is shared client-side so related links can update without a full page load.

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
tempo-docs Ready Ready Preview, Comment Jul 29, 2026 4:54pm

Request Review

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