发布

RSS 订阅源

2.2.3-6112 7df8e8328f

比较
docs: fix broken links and rendering bugs in the Python SDK reference & docs (#7558)

frostbyte_neo 发布于 2026-07-22 10:48:59 +00:00
- fix(python-sdk-docs): correct broken links, typos, and eval example on SDK reference home
- Tracing/Evaluation links returned 404: repoint to
  /tracing/advanced/log_traces and /evaluation/advanced/evaluate_your_llm
  (the Evaluation URL also had a // double slash)
- Typos: "In includes"->"It includes", "To get start"->"To get started",
  "functionc"->"function", "Comet Opik as"->"Comet Opik has"
- Evaluation example: EqualsMetric/HallucinationMetric -> Equals/Hallucination
  (actual class names), add missing import openai, drop the duplicate
  from typing import Dict
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
- fix(python-sdk): fix span() UUIDv7 link and render prompt-history examples as code
- Opik.span() docstring: the id param linked to uuid.ramsey.dev's UUID v8
  page (a PHP library); point it to https://uuid7.com/ to match trace() and
  the sibling trace_id param.
- get_prompt_history / get_chat_prompt_history / get_prompts_client: their
  Example blocks were plain-indented, so Sphinx/napoleon rendered them as
  prose (with smart-quoted text) instead of code. Wrap each in an explicit
  .. code-block:: python so they render as code blocks like every other
  example in this module.
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
- fix(docs): repair broken SDK-reference links in the Reference tab and redirects
- reference/overview + integrations/overview: the "Python SDK docs" card and
  the nav "Reference" link pointed at the bare .../python-sdk-reference/
  directory, which 404s without a trailing slash. Point them at
  .../index.html, which always resolves.
- reference/overview: the "Ruby OpenTelemetry SDK docs" card linked to
  /reference/ruby-otel-sdk/overview, which is not a page in the latest nav, so
  the link escaped the /docs/opik base path and dumped users on the Comet app
  shell. Repoint to /integrations/opentelemetry-ruby-sdk (its current home).
- docs.yml: two redirects (log_agents, dynamic_tracing_control) sent users to
  /docs/opik/tracing/log_traces, which 404s (the page moved under advanced/).
  Point them at /docs/opik/tracing/advanced/log_traces.
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
- fix(docs): stop the SEO generator from doubling the site suffix in ".
  
  Emit headline = "{title}" and let Fern add the single suffix. (Existing pages
  still carry the baked-in suffix in their frontmatter; those are stripped
  separately.)
  
  Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
  - fix(docs): strip redundant "| Opik Documentation" from page headlines
  Fern appends the site title to every page ".
  
  Remove the baked-in suffix from all 240 latest (docs-v2) page headlines;
  combined with the generator fix, titles now render as
  "Quickstart | Opik Documentation". Purely mechanical: only the frontmatter
  headline: line is changed in each file.
  
  Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com
  
  Co-authored-by: Claude Opus 4.8 (1M context) noreply@anthropic.com
下载附件
- 源代码 (ZIP)
- 源代码 (TAR.GZ)

0 发布 8,340 Git 标签

docs: fix broken links and rendering bugs in the Python SDK reference & docs (#7558)