docs: restructure sidebar — split Observability from Evaluation, move LLM-as-a-Judge to How-To#895
Open
ajbozarth wants to merge 3 commits intogenerative-computing:mainfrom
Open
Conversation
Removes the nested Telemetry dropdown in favour of flat page entries directly under the Evaluation and Observability group, and drops the redundant sidebarTitle override on the Telemetry overview page. Closes generative-computing#838 Assisted-by: Claude Code Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
github-actions
Bot
added
the
documentation
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Contributor
Author
|
Edit: after discussion over slack I misunderstood the goal, I fully support this updated implementation |
… How-To Move `evaluate-with-llm-as-a-judge` to the How-To section and rename the remaining group from "Evaluation and Observability" to "Observability". Rename the folder from `evaluation-and-observability/` to `observability/` to match. Add redirects for all old URLs. Update all internal cross-links and add a contextual link from the requirements-system concepts page. Assisted-by: Claude Code Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
ajbozarth
changed the title
Contributor
Author
|
After discussion with @abrahamdaniels over Slack we reworked the intent of this PR. I updated the description to match the new intent and this is ready for review again |
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.
Misc PR
Type of PR
Description
Restructures the docs sidebar in two ways:
Flatten Telemetry sub-group: the nested "Telemetry" dropdown is removed; the four observability pages (Telemetry, Tracing, Metrics, Logging) are now listed flat. Also removes the redundant
sidebarTitle: "Overview"override fromtelemetry.md.Split "Evaluation and Observability": moves
evaluate-with-llm-as-a-judgeinto the How-To section (it was already taggeddiataxis: how-to) and renames the remaining group to "Observability". Renames the folder fromevaluation-and-observability/toobservability/to match, with redirects for all old URLs. Adds a contextual link to the evaluate page from the Requirements System concepts page.Before (closed):
Before (open):
After — Observability section:
After — How-To section:
Testing
Attribution