Skip to content

[NA] [DOCS] fix: remove dead doc links and fix occured typos #8164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simpleqt wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −12
Open

[NA] [DOCS] fix: remove dead doc links and fix occured typos #8164

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b9c9d9
[NA] [DOCS] fix: remove dead doc links and fix occured typos
simpleqt Sep 4, 2026
03e96ac
[NA] [DOCS] fix: renumber remaining TOC entries (10-12) after anchor fix
simpleqt Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions apps/opik-backend/docs/JAVA_PYTHON_RQ_INTEGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ curl http://localhost:8080/v1/internal/hello-world/queue-size
2. [Architecture](#architecture)
3. [Detailed Setup](#detailed-setup)
4. [Components](#components)
6. [OpenTelemetry Metrics](#opentelemetry-metrics)
7. [Configuration](#configuration)
8. [Usage Guide](#usage-guide)
9. [Adding New Queues](#adding-new-queues)
10. [Testing](#testing)
5. [OpenTelemetry Metrics](#opentelemetry-metrics)
6. [Queue Configuration](#queue-configuration-configyml)

@baz-reviewer baz-reviewer Bot Sep 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Severity

Want Baz to fix this for you? Activate Fixer

Other fix methods

Fix in Cursor

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.

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)

@baz-reviewer baz-reviewer Bot Sep 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Severity

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

Fix in Cursor

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.

Expand Down
2 changes: 1 addition & 1 deletion sdks/python/src/opik/plugins/pytest/decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
test_runs_storage.TEST_RUNS_CONTENTS[node_id] = test_run_content_
except Exception:
LOGGER.error(
"Unexpected exception occured during llm_unit test tracking for test %s",
"Unexpected exception occurred during llm_unit test tracking for test %s",
func.__name__,
exc_info=True,
)
Expand Down
4 changes: 2 additions & 2 deletions sdks/python/src/opik/plugins/pytest/hooks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,13 @@ def pytest_sessionfinish(session: "pytest.Session", exitstatus: Any) -> None:
client.flush()
except Exception:
LOGGER.error(
"Unexpected exception occured while trying to log LLM unit tests experiment results",
"Unexpected exception occurred while trying to log LLM unit tests experiment results",
exc_info=True,
)


@_logging.convert_exception_to_log_message(
"Unexpected exception occured while trying to print LLM unit tests summary",
"Unexpected exception occurred while trying to print LLM unit tests summary",
logger=LOGGER,
exc_info=True,
logging_level=logging.DEBUG,
Expand Down
1 change: 0 additions & 1 deletion sdks/typescript/design/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Comprehensive architecture documentation for contributors and team members. Thes
| Document | Priority | Description |
|----------|----------|-------------|
| **[API and Data Flow](API_AND_DATA_FLOW.md)** | ⭐ Start Here | Core architecture, client design, batch queues, async patterns |
| **[Tracing](TRACING.md)** | ⭐ Start Here | Trace/span model, native API, `track` decorator, integrations, config — usage-focused onboarding |
| **[Testing](TESTING.md)** | 🔵 Essential | Test categories, MSW mocking, Vitest patterns |
| **[Integrations](INTEGRATIONS.md)** | 🟣 As Needed | Integration patterns (Proxy, Callback, Exporter), streaming support |
| **[Evaluation](EVALUATION.md)** | 🟣 As Needed | Evaluation engine, metrics architecture, prompt evaluation |
Expand Down