Restructure docs: instrumentation before evals #33
Conversation
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
Reorganize README to follow a clearer user journey: 1. Install 2. Instrumentation (auto recommended, manual linked) 3. Evaluations 4. API Client Move manual instrumentation examples to trace/contrib/README.md to keep the main README focused on the recommended auto path. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Show alternative to `orchestrion go build` using GOFLAGS for users who prefer standard go commands. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
jseldess
approved these changes
Jan 17, 2026
Contributor
jseldess
left a comment
jseldess
left a comment
There was a problem hiding this comment.
LGTM. Let me know when this is in a release and I'll add it to our docs quickstart.
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.
Reorganize README to follow a clearer user journey:
Move manual instrumentation examples to trace/contrib/README.md to keep the main README focused on the recommended auto path.