Skip to content

feat: add do11y documentation observability#375

Draft
JakeSCahill wants to merge 2 commits intomainfrom
feature/add-do11y
Draft

feat: add do11y documentation observability#375
JakeSCahill wants to merge 2 commits intomainfrom
feature/add-do11y

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

@JakeSCahill JakeSCahill commented Apr 22, 2026 •
edited
Loading

Summary

  • Add Axiom do11y integration for documentation engagement tracking
  • Track page views, scroll depth, code copy events, TOC clicks, AI referral traffic
  • Configuration uses edge function proxy (token stored server-side in Netlify)

Setup Required

After merging, set these environment variables in Netlify:

  • AXIOM_DO11Y_TOKEN - Axiom API ingest token
  • AXIOM_DO11Y_DATASET - Dataset name (defaults to redpanda-docs-analytics)

Related PR

Test plan

  • Build UI bundle locally
  • Verify do11y.js loads on pages
  • Verify events are sent to /api/do11y endpoint
  • Verify no API token in client-side code

🤖 Generated with Claude Code

JakeSCahill and others added 2 commits April 21, 2026 16:08
@JakeSCahill @claude
Add timeouts to validate-build workflow steps
e800357 
Prevents workflow hangs when steps intermittently freeze:
- Lint Go code: 10-minute timeout (normal: 3 seconds)
- Bundle UI: 15-minute timeout (normal: 5.5 minutes)

Recent pattern: 11 of 30 runs cancelled after 64+ minute hangs.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JakeSCahill @claude
feat: add do11y documentation observability
403e83b 
Add Axiom do11y integration for tracking documentation engagement:
- Page views and scroll depth
- Code block copy events
- TOC clicks and navigation
- AI referral traffic detection

The configuration uses a Netlify edge function proxy to keep
the Axiom API token server-side. Requires AXIOM_DO11Y_TOKEN
environment variable to be set in Netlify.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 22, 2026 •
edited
Loading

✅ Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit 403e83b
🔍 Latest deploy log https://app.netlify.com/projects/docs-ui/deploys/69e88b88157c710008a69bb9
😎 Deploy Preview https://deploy-preview-375--docs-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 35 (🔴 down 2 from production)
Accessibility: 93 (no change from production)
Best Practices: 83 (🔴 down 9 from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 22, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e2526931-3961-4bd6-9bf6-6e0b8c6c87b1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/add-do11y

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@JakeSCahill JakeSCahill mentioned this pull request Apr 22, 2026
Draft
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JakeSCahill