Skip to content

docs(llma): update TOC for OTel onboarding migration#16236

Open
richardsolomou wants to merge 6 commits intomasterfrom
docs/otel-llm-analytics
Open

docs(llma): update TOC for OTel onboarding migration#16236
richardsolomou wants to merge 6 commits intomasterfrom
docs/otel-llm-analytics

Conversation

@richardsolomou
Copy link
Copy Markdown
Member

@richardsolomou richardsolomou commented Apr 8, 2026

Changes

Updates tableOfContents frontmatter in LLM analytics installation docs to match the new step titles from the OTel migration in PostHog/posthog#53668.

Each migrated doc now uses a 3-step TOC:

  1. Install dependencies
  2. Set up OpenTelemetry tracing
  3. Call/Run {provider}
  4. Verify traces and generations

Docs updated:

  • OpenAI-compatible: openai, groq, deepseek, mistral, cohere, fireworks-ai, xai, hugging-face, openrouter, together-ai, ollama, cerebras, perplexity
  • Gateways: portkey, helicone
  • Azure OpenAI, Anthropic
  • Frameworks: langchain, langgraph, llamaindex
  • autogen, instructor, mirascope, semantic-kernel, smolagents, pydantic-ai
  • Mastra (now using @mastra/posthog exporter — 3-step TOC)
  • Manual capture (added a TOC for the first time — Capture LLM events manually → Event properties → Verify traces and generations)

Also includes a branch-pinning change in gatsby-config.js and gatsby/onPreBootstrap.ts to point at docs/otel-onboarding-docs in the posthog repo, so the Vercel preview build shows the new docs before PostHog/posthog#53668 lands. Must be reverted to master before merging.

Note: This PR should be merged after PostHog/posthog#53668 lands, since the TOC entries reference the new step titles from that PR.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json

Update tableOfContents entries to match the new step titles from
the posthog repo's OTel migration. Old steps like "Install the
PostHog SDK" / "Initialize PostHog and OpenAI client" are now
"Install dependencies" / "Set up OpenTelemetry tracing".
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Apr 09, 2026 08:23AM

@richardsolomou richardsolomou marked this pull request as ready for review April 8, 2026 09:43
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Vale prose linter → found 0 errors, 21 warnings, 0 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/llm-analytics/installation/autogen.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning 'autogen' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/cerebras.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Cerebras' is a possible misspelling. PostHogBase.Spelling
3:15 warning 'cerebras' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/deepseek.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'DeepSeek' instead of 'deepseek'. Vale.Terms
contents/docs/llm-analytics/installation/groq.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'Groq' instead of 'groq'. Vale.Terms
contents/docs/llm-analytics/installation/helicone.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Helicone' is a possible misspelling. PostHogBase.Spelling
3:15 warning 'helicone' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/hugging-face.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning 'huggingFace' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/langgraph.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning 'langgraph' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/llamaindex.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning 'llamaindex' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/mastra.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Mastra' is a possible misspelling. PostHogBase.Spelling
3:15 warning 'mastra' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/mirascope.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Mirascope' is a possible misspelling. PostHogBase.Spelling
3:15 warning 'mirascope' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/ollama.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'Ollama' instead of 'ollama'. Vale.Terms
contents/docs/llm-analytics/installation/portkey.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Portkey' is a possible misspelling. PostHogBase.Spelling
3:15 warning 'portkey' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/pydantic-ai.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'Pydantic' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/semantic-kernel.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning 'semanticKernel' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/smolagents.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
2:8 warning 'smolagents' is a possible misspelling. PostHogBase.Spelling
contents/docs/llm-analytics/installation/xai.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'xAI' instead of 'xai'. Vale.Terms

@richardsolomou richardsolomou requested a review from a team April 8, 2026 09:43
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