docs(traceai): add Overview and Quickstart#709
Open
abhijaisrivastava15 wants to merge 1 commit into
Open
Conversation
New top-level traceAI section: an Overview (what traceAI is, languages, how it fits with Observe) and a Quickstart (install an instrumentor, register, trace one call, confirm in Observe). Grounded in the traceAI SDK README and the shipped Observe quickstart pattern.
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
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.
What
Starts the traceAI section Khushal asked for: an Overview and a Quickstart, the two pages he wants to align on before we build out the rest.
Pages added
src/pages/docs/traceai/index.mdx— Overview: what traceAI is, what it captures, the four languages + 50+ frameworks, and how it fits with Observe / any OTel backendsrc/pages/docs/traceai/quickstart.mdx— Quickstart: install an instrumentor, register a project, trace one OpenAI call, confirm it in Observe (Python + JS/TS)Grounding
Every claim is from source, not another doc:
future-agi/traceAIREADMEregister(project_type=ProjectType.OBSERVE, ...)/FI_API_KEY+FI_SECRET_KEY/Transport.GRPC— traceAI README + the shipped Observe quickstart (same verified pattern)Notes for you (Khushal)
navigation.ts. Pages are live by URL for review:/docs/traceaiand/docs/traceai/quickstart. Titles will sync to whatever sidebar labels you pick./docs/observe/quickstartby design (traceAI SDK-first vs Observe platform-first). Want me to keep both, or make Observe's point here?Preview
Then: http://localhost:4444/docs/traceai and http://localhost:4444/docs/traceai/quickstart