Skip to content

Remove retired product provenance - #13

Merged
Mile-Away merged 1 commit into
mainfrom
codex/independent-provenance-cleanup
Sep 12, 2026
Merged

Mile-Away merged 1 commit into
mainfrom
codex/independent-provenance-cleanup

Conversation

@Mile-Away

@Mile-Away Mile-Away commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • remove retired product names and provenance commentary
  • document the current Electron-supervised OpenSDL runtime contract
  • use product-neutral media endpoint examples

Verification

  • independent module review passed
  • mandatory thermo-nuclear staged-diff review passed
  • documentation and configuration scans passed

Sourcery 总结

移除已停用的产品引用,并使 OpenSDL 文档和媒体示例与当前产品中立的运行时及部署模型保持一致。

改进:

  • 记录当前由 Electron 监管的 OpenSDL 客户端/服务器运行时契约和部署模型。
  • 针对可配置的远程 SRS 部署,泛化媒体网关指南和示例,包括支持 TLS 的播放端点。

文档:

  • 从项目文档和示例中移除已停用的产品名称、内部来源信息以及特定于部署的说明。
Original summary in English

Summary by Sourcery

Remove retired product references and align OpenSDL documentation and media examples with the current product-neutral runtime and deployment model.

Enhancements:

  • Document the current Electron-supervised OpenSDL client/server runtime contract and deployment model.
  • Generalize media gateway guidance and examples for configurable remote SRS deployments, including TLS-aware playback endpoints.

Documentation:

  • Remove retired product names, internal provenance, and deployment-specific commentary from project documentation and examples.

@sourcery-ai

sourcery-ai Bot commented Sep 12, 2026

Copy link
Copy Markdown

审查者指南

该 PR 移除了已停用的产品名称、部署主机名和来源说明,同时更新文档与示例,以描述当前由 SciLaxy/Electron 监督的 lab serve 架构,以及产品中立的媒体端点契约。

桌面端监督的实验室服务器启动时序图

sequenceDiagram
    participant Electron as Electron main process
    participant LabServe as lab serve
    participant Runner as scilaxy-runner
    participant Engine as OpenSDL engine

    Electron->>LabServe: start process
    LabServe-->>Electron: readiness
    Electron->>Runner: configure gRPC endpoint
    Runner->>LabServe: gRPC request
    LabServe->>Engine: execute request
    Engine-->>LabServe: response and OsdlEvent
    LabServe-->>Runner: gRPC response and event
Loading

媒体端点契约流程图

flowchart LR
    Config[Remote RTMP configuration]
    Ingest[RTMP ingest endpoint\ningest.media.example]
    Engine[OpenSDL media endpoint builder]
    Playback[HTTPS playback endpoint\nplayback.media.example]
    Browser[HTTPS browser frontend]

    Config -->|base_url| Ingest
    Config -->|http_host and webrtc_host| Engine
    Ingest -->|published stream| Engine
    Engine -->|HLS, HTTP-FLV, WHEP URLs| Playback
    Playback --> Browser
Loading

文件级变更

变更 详细信息 文件
围绕当前产品和桌面端监督的运行时契约,重新定义文档中的集成模型。
  • 将集成相关引用重命名为 SciLaxy,并移除已停用的 Tauri/捆绑引擎术语。
  • 记录 Electron 对独立 lab serve 进程的监督机制。
  • 明确 Runner 仅使用生成的 osdl-proto gRPC 客户端,而 OpenSDL 引擎/服务器 crate 仍保留在独立进程中。
  • 更新架构图和入门指南,以反映已配置的 gRPC 端点和云端 WebSocket 转发。
CLAUDE.md
README.md
docs/architecture.md
docs/cs-architecture.md
docs/getting-started.md
移除特定部署的媒体来源信息,并替换为产品中立的端点指南。
  • 将生产环境主机名和基础设施细节替换为保留的示例域名。
  • 说明 ingest、播放和 WebRTC 的独立职责,但不将其绑定到特定部署。
  • 保留并明确浏览器在 TLS 终止之后进行播放时对 HTTPS 前缀的要求。
  • 更新媒体配置注释、冒烟测试命令和端点测试,以使用中立示例。
crates/osdl-core/src/media/mod.rs
crates/osdl-core/src/media/onvif_camera.rs
docs/recipes/configs/onvif-camera.yaml
docs/recipes/media-gateway.md
清理测试和配方中残留的已停用产品配置及来源引用。
  • 从集成文档和总线清单文档中移除特定产品的主目录和 Runner 来源信息。
  • 保留底层清单验证行为,同时使示例不依赖特定产品。
crates/osdl-core/tests/integration.rs
docs/recipes/bus-manifest.md

提示和命令

与 Sourcery 交互

  • 触发新的审查: 在 pull request 中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 从审查评论生成 GitHub issue: 回复审查评论,请 Sourcery 根据该评论创建 issue。你也可以使用 @sourcery-ai issue 回复审查评论,以从中创建 issue。
  • 生成 pull request 标题: 在 pull request 标题的任意位置写入 @sourcery-ai,即可随时生成标题。你也可以在 pull request 中评论 @sourcery-ai title,以随时生成或重新生成标题。
  • 生成 pull request 摘要: 在 pull request 正文的任意位置写入 @sourcery-ai summary,即可在指定位置随时生成 PR 摘要。你也可以在 pull request 中评论 @sourcery-ai summary,以随时生成或重新生成摘要。
  • 生成审查者指南: 在 pull request 中评论 @sourcery-ai guide,以随时生成或重新生成审查者指南。
  • 解决所有 Sourcery 评论: 在 pull request 中评论 @sourcery-ai resolve,以解决所有 Sourcery 评论。如果你已经处理完所有评论且不想再看到它们,此功能会很有用。
  • 关闭所有 Sourcery 审查: 在 pull request 中评论 @sourcery-ai dismiss,以关闭所有现有的 Sourcery 审查。如果你想从新的审查开始,这一功能尤其有用——别忘了评论 @sourcery-ai review 以触发新的审查!

自定义你的使用体验

访问你的控制面板以:

  • 启用或禁用审查功能,例如 Sourcery 生成的 pull request 摘要、审查者指南等。
  • 更改审查语言。
  • 添加、移除或编辑自定义审查指令。
  • 调整其他审查设置。

获取帮助

Original review guide in English

Reviewer's Guide

The PR removes retired product names, deployment hostnames, and provenance commentary while updating documentation and examples to describe the current SciLaxy/Electron-supervised lab serve architecture and product-neutral media endpoint contract.

Sequence diagram for desktop-supervised lab server startup

sequenceDiagram
    participant Electron as Electron main process
    participant LabServe as lab serve
    participant Runner as scilaxy-runner
    participant Engine as OpenSDL engine

    Electron->>LabServe: start process
    LabServe-->>Electron: readiness
    Electron->>Runner: configure gRPC endpoint
    Runner->>LabServe: gRPC request
    LabServe->>Engine: execute request
    Engine-->>LabServe: response and OsdlEvent
    LabServe-->>Runner: gRPC response and event
Loading

Flow diagram for the media endpoint contract

flowchart LR
    Config[Remote RTMP configuration]
    Ingest[RTMP ingest endpoint\ningest.media.example]
    Engine[OpenSDL media endpoint builder]
    Playback[HTTPS playback endpoint\nplayback.media.example]
    Browser[HTTPS browser frontend]

    Config -->|base_url| Ingest
    Config -->|http_host and webrtc_host| Engine
    Ingest -->|published stream| Engine
    Engine -->|HLS, HTTP-FLV, WHEP URLs| Playback
    Playback --> Browser
Loading

File-Level Changes

Change Details Files
Reframe the documented integration model around the current product and desktop-supervised runtime contract.
  • Rename integration references to SciLaxy and remove retired Tauri/bundled-engine terminology.
  • Document Electron supervision of a standalone lab serve process.
  • Clarify that Runner uses only the generated osdl-proto gRPC client and that OpenSDL engine/server crates remain in the standalone process.
  • Update architecture diagrams and getting-started guidance to reflect configured gRPC endpoints and cloud WebSocket forwarding.
CLAUDE.md
README.md
docs/architecture.md
docs/cs-architecture.md
docs/getting-started.md
Remove deployment-specific media provenance and replace it with product-neutral endpoint guidance.
  • Replace production hostnames and infrastructure details with reserved example domains.
  • Explain separate ingest, playback, and WebRTC roles without tying them to a specific deployment.
  • Retain and clarify HTTPS-prefix requirements for browser playback behind TLS termination.
  • Update media configuration comments, smoke-test commands, and endpoint tests to use neutral examples.
crates/osdl-core/src/media/mod.rs
crates/osdl-core/src/media/onvif_camera.rs
docs/recipes/configs/onvif-camera.yaml
docs/recipes/media-gateway.md
Clean up remaining retired product configuration and provenance references in tests and recipes.
  • Remove product-specific home-directory and runner provenance from integration and bus-manifest documentation.
  • Preserve the underlying manifest validation behavior while making the examples product-neutral.
crates/osdl-core/tests/integration.rs
docs/recipes/bus-manifest.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai 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.

嘿——我已经审查了你的更改,看起来很棒!


Sourcery 对开源项目免费——如果你喜欢我们的评审,欢迎考虑分享 ✨
Original comment in English

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@Mile-Away
Mile-Away merged commit 57519aa into main Sep 12, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant