docs(examples): fix doc link paths on agent-observability-docs.splunk.com (HYBIM-932 follow-up) - #192
docs(examples): fix doc link paths on agent-observability-docs.splunk.com (HYBIM-932 follow-up)#192shuningc wants to merge 3 commits into
Conversation
….com The new docs site moved metrics content under concepts/evaluators/. Update six example README links that 404'd after the domain-only swap, and point experiments docs at the canonical sdk-api path. Co-authored-by: Cursor <cursoragent@cursor.com>
pipx-installed invoke is not on PATH in PowerShell on windows-latest, causing invoke test-report-xml to fail. Use poetry run invoke instead since invoke is already a dev dependency. Co-authored-by: Cursor <cursoragent@cursor.com>
4ceb257 to
03f88ab
Compare
Update MCP setup and CrewAI integration links to match the Splunk AO slugs in agent-observability-docs (setup-splunk-ao-mcp, add-splunk-ao-to-crewai). Co-authored-by: Cursor <cursoragent@cursor.com>
fercor-cisco
left a comment
fercor-cisco
left a comment
There was a problem hiding this comment.
🤖 This review was generated by the Astra agent (claude-opus-4-8). It may contain mistakes.
Verdict: needs_discussion — Diff contradicts the PR description on which links were changed, and includes an undocumented out-of-scope CI change; URL correctness could not be independently verified.
General Comments
- 🟠 major (question): The diff contradicts the PR description. The description explicitly lists these URLs under "Not changed — verified as 200 OK on the new domain with existing paths — no edits needed":
.../add-galileo-to-crewai/add-galileo-to-crewai.../getting-started/mcp/setup-galileo-mcp
But the diff rewrites all three occurrences to add-splunk-ao-to-crewai/add-splunk-ao-to-crewai (crewAI/README.md, research_crew/README.md ×2) and setup-splunk-ao-mcp (log-mcp-calls/README.md). For a PR whose sole purpose is fixing link paths, this is a direct inconsistency: either the description's "200 OK, no edits" claim is stale, or these edits change links that already worked and now risk 404s. Please confirm the current resolution status of both the old (galileo) and new (splunk-ao) slugs and reconcile the description with the diff. (I could not verify the URLs from this environment — the docs domain is not fetchable here.)
| - name: Install Dependencies | ||
| run: invoke install | ||
| run: poetry install --all-extras --no-root |
There was a problem hiding this comment.
🟡 minor (design): This CI workflow change (removing the pipx install invoke step, switching invoke install → poetry install --all-extras --no-root, and prefixing poetry run to the invoke calls) is unrelated to the PR's stated purpose (docs(examples): fix doc link paths) and is not mentioned anywhere in the description. The change itself looks functionally correct — invoke is declared in the Poetry dev group, so poetry run invoke type-check / poetry run invoke test-report-xml resolve after poetry install. But this scope creep should either be split into its own PR or called out explicitly in the description so reviewers know to evaluate it.
🤖 Generated by the Astra agent
There was a problem hiding this comment.
Updated the PR description to match the changes. The CI workflow is to fix one of the failed pipeline for this PR.
2 participants
Summary
Follow-up to #181, which swapped example doc links from
docs.galileo.aitoagent-observability-docs.splunk.com. That domain-only change left several paths returning 404 after upstream docs restructures (august-rebrand-updatesin agent-observability-docs):concepts/metrics/…moved underconcepts/evaluators/…setup-galileo-mcp→setup-splunk-ao-mcp,add-galileo-to-crewai→add-splunk-ao-to-crewai(no redirects added upstream yet)concepts/experiments/overview→sdk-api/experiments/experimentsThis PR updates the broken example README links to match the current docs site and fixes a Windows CI failure unrelated to the doc changes.
Documentation link fixes (9 README files)
concepts/metrics/response-quality/instruction-adherenceconcepts/evaluators/response-quality/instruction-adherenceconcepts/metrics/response-quality/correctnessconcepts/evaluators/response-quality/correctnessconcepts/metrics/metric-comparisonconcepts/evaluators/evaluator-comparisonexamples/experiments/multi-turn/README.mdconcepts/metrics/custom-metrics/custom-metrics-ui-llmconcepts/evaluators/custom-evaluators/custom-evaluators-ui-llmexamples/experiments/upload_experiment/README.mdconcepts/experiments/overviewsdk-api/experiments/experimentsexamples/agent/langgraph-fsi-agent/README.mdgetting-started/mcp/setup-galileo-mcpgetting-started/mcp/setup-splunk-ao-mcpexamples/logging-samples/log-mcp-calls/README.mdhow-to-guides/…/add-galileo-to-crewai/add-galileo-to-crewaihow-to-guides/…/add-splunk-ao-to-crewai/add-splunk-ao-to-crewaiexamples/agent/crewAI/README.md,research_crew/README.mdagent-observability-docs.splunk.comURLs referenced in this repo were verified (HTTP 200). Remaining root/links redirect correctly and were left unchanged.CI workflow fix (
.github/workflows/ci-tests.yaml)On
windows-latest,pipx install invokesucceeds butinvokeis not on the PowerShell PATH, causinginvoke type-check/invoke test-report-xmlto fail.invokeis already a Poetry dev dependency, so the workflow now:pipx install invokesteppoetry install --all-extras --no-root(replacinginvoke install)poetry run invoke type-checkandpoetry run invoke test-report-xmlContext
main)august-rebrand-updates(merged as splunk/agent-observability-docs#33) and the metrics→evaluators migrationTest plan
docs.galileo.ai,concepts/metrics/, or galileo-branded doc slugs in example READMEsagent-observability-docs.splunk.comURLs return 200.mdxpaths inagent-observability-docsmainCI - Testpasses on Ubuntu, macOS, and Windows (especially Python matrix onwindows-latest)