Skip to content

LCORE-5403: regenerated devel doc - #3193

Merged
tisnik merged 2 commits into
lightspeed-core:mainfrom
tisnik:lcore-5403-regenerated-devel-doc
Nov 10, 2026
Merged

tisnik merged 2 commits into
lightspeed-core:mainfrom
tisnik:lcore-5403-regenerated-devel-doc

Conversation

@tisnik

@tisnik tisnik commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Description

LCORE-5403: regenerated devel doc

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library [pyproject.toml + uv.lock]
  • Bump-up dependent library [requirements.*.txt for Konflux]
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-5403

Summary by CodeRabbit

  • Documentation
    • Updated observability documentation with information about the span exporter that redacts personally identifiable information before sending data to OTLP.
    • Added documentation entries for the redacting exporter’s unit tests and A2A JSON-RPC endpoint integration tests.
    • Revised the endpoints test listing to describe the A2A integration coverage.

@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation generator now skips the Bedrock inference provider path. README listings now describe the redacting span exporter, its unit test, and the A2A endpoint integration test.

Changes

Documentation updates

Layer / File(s) Summary
Documentation generation exclusion
scripts/gen_doc.py
The generator now skips src/providers/inference/bedrock during documentation generation.
README listings
src/observability/README.md, tests/unit/observability/README.md, tests/integration/endpoints/README.md
The READMEs add descriptions for the redacting span exporter and its unit test. The endpoints README updates the listing for test_a2a_integration.py.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Suggested labels: documentation, Review effort 1/5, risk/low, python

Suggested reviewers: snuryyeva, fullsend-ai-review

Merge Risk: Minimal · up to d8c4b

The changes update documentation listings and generation exclusions; no material merge risk is identified.

Pre-merge checks: Passed 7

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title says the development documentation was regenerated, which matches the pull request’s documentation changes.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Performance And Algorithmic Complexity Passed PASSED. The code change skips README generation for one directory. The other changes update README content. The diff introduces no listed performance regression.
Security And Secret Handling Passed PASSED. The PR updates README entries and excludes one directory from README generation. The changes introduce no listed security violations.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (3 skipped: 3 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
Simplify code

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 09fa905 and d8c4b69.

Files selected for processing: 4

  • scripts/gen_doc.py
  • src/observability/README.md
  • tests/integration/endpoints/README.md
  • tests/unit/observability/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Recent review details

Context from checks skipped due to timeout: 37

  • GitHub Check: dispatch / Review
  • GitHub Check: E2E: library / ci / authorized
  • GitHub Check: E2E: library / ci / shields
  • GitHub Check: E2E: library / ci / mcp
  • GitHub Check: E2E: server / ci / default
  • GitHub Check: E2E: server / ci / tls
  • GitHub Check: E2E: library / ci / other
  • GitHub Check: E2E: server / ci / authorized
  • GitHub Check: E2E: library / ci / skills
  • GitHub Check: E2E: library / ci / rbac
  • GitHub Check: E2E: library / ci / default
  • GitHub Check: E2E: server / ci / shields
  • GitHub Check: E2E: server / ci / other
  • GitHub Check: E2E: server / ci / mcp
  • GitHub Check: E2E: server / ci / skills
  • GitHub Check: E2E: server / ci / rbac
  • GitHub Check: build-pr
  • GitHub Check: ruff
  • GitHub Check: shellcheck
  • GitHub Check: spectral
  • GitHub Check: bandit
  • GitHub Check: integration_tests (3.12)
  • GitHub Check: integration_tests (3.13)
  • GitHub Check: Pyright
  • GitHub Check: unit_tests (3.12)
  • GitHub Check: check_dependencies
  • GitHub Check: integration_tests (3.14)
  • GitHub Check: Pylinter
  • GitHub Check: unit_tests (3.13)
  • GitHub Check: black
  • GitHub Check: unit_tests (3.14)
  • GitHub Check: radon
  • GitHub Check: Red Hat Konflux / lightspeed-core-0-8-enterprise-contract / lightspeed-stack-0-8
  • GitHub Check: Red Hat Konflux / lightspeed-stack-0-8-e2e-tests / lightspeed-stack-0-8
  • GitHub Check: check
  • GitHub Check: Red Hat Konflux / rag-content-0-8-e2e-tests / lightspeed-stack-0-8
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-8-on-pull-request
Additional context used

Code guidelines: 2

CLAUDE.md — auto-discovered
AGENTS.md — auto-discovered
Path-based instructions: 6

Source excerpt: **Required**: Use pytest for all unit and integration tests Source excerpt: **Forbidden**: Do not use unittest - pytest is the standard for this project Source excerpt: **Coverage**: Unit tests require 60% coverage, integrat...

CodeRabbit inference engine (CLAUDE.md)

Files:

  • tests/unit/observability/README.md
  • tests/integration/endpoints/README.md
Source excerpt: Use absolute imports for internal modules: `from authentication import get_auth_dependency` Source excerpt: FastAPI dependencies: `from fastapi import APIRouter, HTTPException, Request, status, Depends` Source excerpt: OGX i...

CodeRabbit inference engine (AGENTS.md)

Files:

  • tests/unit/observability/README.md
  • tests/integration/endpoints/README.md
  • scripts/gen_doc.py
  • src/observability/README.md
Source excerpt: **Required**: Use pytest for all unit and integration tests **Forbidden**: Do not use unittest - pytest is the standard for this project Source excerpt: **Coverage**: Unit tests require 60% coverage, integration 10%

CodeRabbit inference engine (AGENTS.md)

Files:

  • tests/unit/observability/README.md
  • tests/integration/endpoints/README.md
Source excerpt: **Fixtures**: Use `conftest.py` for shared fixtures Source excerpt: **Mocking**: `pytest-mock` for AsyncMock objects

CodeRabbit inference engine (AGENTS.md)

Files:

  • tests/unit/observability/README.md
Source excerpt: **Mocking**: `pytest-mock` for AsyncMock objects Source excerpt: **Auth Mock**: `MOCK_AUTH = ("mock_user_id", "mock_username", False, "mock_token")`

CodeRabbit inference engine (CLAUDE.md)

Files:

  • tests/unit/observability/README.md
Source excerpt: **Async tests**: Use marker `pytest.mark.asyncio`

CodeRabbit inference engine (AGENTS.md)

Files:

  • tests/unit/observability/README.md
  • tests/integration/endpoints/README.md
Additional comments: 4

scripts/gen_doc.py: 1

15-15: LGTM!

src/observability/README.md: 1

11-14: LGTM!

tests/unit/observability/README.md: 1

11-14: LGTM!

tests/integration/endpoints/README.md: 1

11-14: LGTM!

@fullsend-ai-review

fullsend-ai-review Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:54 AM UTC · Completed 8:03 AM UTC

Commit: d8c4b69 · View workflow run →

Runtime: pi · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.52

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [protected-path] scripts/gen_doc.py:15 — This PR modifies scripts/gen_doc.py, which is under the protected path scripts/. The PR links to JIRA issue LCORE-5403 and explains the rationale (documentation regeneration required adding src/providers/inference/bedrock to the skip list). Human approval is always required for protected-path changes, regardless of context.

Risk assessment missing — risk assessment is enabled but no score was
produced. A human reviewer must evaluate this PR.


Labels: PR is a documentation regeneration update touching only docs and the doc-generation script.

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review comment for full details.

Comment thread scripts/gen_doc.py
DIRS_TO_SKIP = {
"src/pii_redaction_engine",
"src/providers/inference",
"src/providers/inference/bedrock",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[medium] protected-path

This PR modifies scripts/gen_doc.py, which is under the protected path scripts/. The PR links to JIRA issue LCORE-5403 and explains the rationale (documentation regeneration required adding src/providers/inference/bedrock to the skip list). Human approval is always required for protected-path changes, regardless of context.

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation Review effort 1/5 labels Nov 10, 2026
@tisnik
tisnik merged commit 5e51195 into lightspeed-core:main Nov 10, 2026
97 of 101 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation requires-manual-review Review requires human judgment Review effort 1/5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant