docs(observe): split Observe + traceAI into product and SDK sections#681
Open
abhijaisrivastava15 wants to merge 3 commits into
Open
docs(observe): split Observe + traceAI into product and SDK sections#681abhijaisrivastava15 wants to merge 3 commits into
abhijaisrivastava15 wants to merge 3 commits into
Conversation
Restructure the Observe docs into two top-level sections — Observe (the product) and traceAI (the instrumentation SDK) — per the locked IA decision. Rewrite pages to the product-docs-playbook bar, add new Getting Started, Quick start, concept, and reference pages, move Manual instrumentation and Framework integrations under traceAI, and add redirects so no existing URL 404s.
|
Automatic Review Skipped Too many files for automatic review. If you would still like a review, you can trigger one manually by commenting: |
…ages Apply review feedback on the Observe + traceAI sections: - Remove the standalone Overview; make Get started the first sidebar item in both Observe and traceAI, for a consistent spine across sections. - Open each landing with a plain "What is X?" that links straight to the trace and span concepts, and link the landing to the reference. - Cut the Observe landing from ~880 to ~280 words to reduce overload; drop the unclear "Why this matters in production" heading and simplify the language.
…eview artifacts Reference reports for the Observe + traceAI revamp: the source/competitor analysis, the locked benchmark (answer key), and the final page-by-page scorecard. Kept under pr-assets/ (outside src/ and public/, so not published to the docs site).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the Observe documentation into two top-level sections — Observe (the product) and traceAI (the instrumentation SDK) — and rewrites the pages to the product-docs-playbook bar. Graded page-by-page against a locked benchmark, the section moves from the 1.8/5 audit baseline → 4.40/5, with every page now at ≥4/5.
This is a fresh PR for the revamp (separate from #640).
Information architecture
audit-linksreports 0 broken links.New pages
Rewrites to depth
Quality — graded against the benchmark
Final pass: every page ≥4/5, 0 pages 404, 0 broken links, build clean (1002 pages).
Reports
Click any report to open it in GitHub's PDF viewer.
Test plan
npm run buildclean (1002 pages)npm run audit-links— 0 broken nav, 0 broken content links