[NA] [DOCS] fix: remove dead doc links and fix occured typos - #8164
[NA] [DOCS] fix: remove dead doc links and fix occured typos#8164simpleqt wants to merge 2 commits into
Conversation
- sdks/typescript/design/README.md: drop the Tracing table row, the linked TRACING.md never existed in the repo - JAVA_PYTHON_RQ_INTEGRATION.md: TOC item 7 pointed at a nonexistent #configuration anchor (the config content is the 'Queue Configuration (config.yml)' subsection); also fix the TOC numbering which skipped 5 - pytest plugin: 'occured' -> 'occurred' in three log messages
github-actions
Bot
added
documentation
There was a problem hiding this comment.
🟡 Changes recommended
The RQ integration guide TOC numbering still has an incorrect gap (9 → 11), which should be fixed for consistency.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR cleans up documentation and user-visible log strings across the TypeScript and Python SDKs, plus the backend RQ integration guide, by removing dead links, fixing an incorrect TOC anchor, and correcting occured typos.
Changes:
- Removed a dead
TRACING.mdlink from the TypeScript SDK design index. - Fixed the RQ integration guide TOC anchor to point at the existing “Queue Configuration (config.yml)” section and partially renumbered the TOC.
- Corrected
occured→occurredin pytest plugin log messages.
File summaries
| File | Description |
|---|---|
| sdks/typescript/design/README.md | Removes a dead documentation link from the TS SDK design index table. |
| sdks/python/src/opik/plugins/pytest/hooks.py | Fixes typo in error/logging text. |
| sdks/python/src/opik/plugins/pytest/decorator.py | Fixes typo in error/logging text. |
| apps/opik-backend/docs/JAVA_PYTHON_RQ_INTEGRATION.md | Updates TOC link/numbering to match an existing “Queue Configuration (config.yml)” anchor. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| 11. [Troubleshooting](#troubleshooting) | ||
| 12. [Design Decisions](#design-decisions) | ||
| 13. [Refactoring History](#refactoring-history) |
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
| 5. [OpenTelemetry Metrics](#opentelemetry-metrics) | ||
| 6. [Queue Configuration](#queue-configuration-configyml) | ||
| 7. [Usage Guide](#usage-guide) | ||
| 8. [Adding New Queues](#adding-new-queues) | ||
| 9. [Testing](#testing) | ||
| 11. [Troubleshooting](#troubleshooting) | ||
| 12. [Design Decisions](#design-decisions) | ||
| 13. [Refactoring History](#refactoring-history) |
There was a problem hiding this comment.
The TOC numbers Testing as 9 but assigns 11 to Troubleshooting, Design Decisions, and Refactoring History, so section 10 is missing — should we renumber those entries 10–12?
Want Baz to fix this for you? Activate Fixer You can also update your AI coding guidelines based on this comment by apply pr to [branch name]
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In
apps/opik-backend/docs/JAVA_PYTHON_RQ_INTEGRATION.md around lines 68-75, fix the table
of contents numbering so the entries form a contiguous sequence. Renumber
`Troubleshooting`, `Design Decisions`, and `Refactoring History` from 11, 12, and 13 to
10, 11, and 12, while preserving their link targets and titles.
| 9. [Adding New Queues](#adding-new-queues) | ||
| 10. [Testing](#testing) | ||
| 5. [OpenTelemetry Metrics](#opentelemetry-metrics) | ||
| 6. [Queue Configuration](#queue-configuration-configyml) |
There was a problem hiding this comment.
Configuration guidance uses wrong variables
The linked Queue Configuration examples use QUEUES_ENABLED, QUEUES_DEFAULT_JOB_TTL, and OPTIMIZER_QUEUE_JOB_TTL with a one-day default, while config.yml consumes OPIK_-prefixed names and defaults the global TTL to 14 days, so operators may leave configuration unchanged and misunderstand job expiry — should we align the examples with config.yml?
Want Baz to fix this for you? Activate Fixer
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In
apps/opik-backend/docs/JAVA_PYTHON_RQ_INTEGRATION.md around line 69, update the Queue
Configuration documentation linked by the TOC so its examples use the OPIK_-prefixed
variable names consumed by config.yml, including the correct queue-specific settings.
Correct the documented global job TTL from one day to the 14-day default defined in
config.yml, and ensure the heading/anchor and TOC link remain consistent.
Details
Three small docs/logging-text fixes: (1) the TypeScript SDK design index linked a
TRACING.mdthat never existed in the repo (verified withgit log --all --follow) — dropped the table row; (2) the RQ integration guide's TOC pointed at a nonexistent#configurationanchor — repointed to the actualQueue Configuration (config.yml)subsection and fixed the numbering that skipped 5; (3) threeoccured→occurredfixes in the pytest plugin's log messages.Change checklist
Issues
AI-WATERMARK
AI-WATERMARK: yes
Testing
Docs-only + log-string changes;
python3 -m compileallon the touched Python files passes. No test asserts the old log strings.Documentation
This PR is the documentation fix.