docs: fix documentation drift from codebase#2
Draft
Sbussiso wants to merge 1 commit into
Draft
Conversation
- Fix outbound API header: X-API-Key → X-Node-API-Key for register/heartbeat - Update ARM64 build status: prebuilt binaries and Docker images are published - Remove tracing-appender from dependencies (not in Cargo.toml) - Add streaming.hls and motion sections to config.example.yaml https://claude.ai/code/session_01DdzBKawH6BhahW6BFiPsEW
Sbussiso
added a commit
that referenced
this pull request
Apr 27, 2026
🔴 #2 from yesterday's code review. Previously the SCM lifecycle was: StartPending → Running → run Config::load → fail → Stopped(1) That sequence briefly showed the service as Running before the config-missing failure was detected, which made services.msc and its consumers report a "service started successfully and then crashed" condition. The truth is closer to "service never reached Running" — and SCM should reflect that. New ordering: StartPending → Config::load + validate → (skip Running on failure) → Stopped(1) If config is fine: StartPending → Running → run node → Stopped(0). Implementation: - Extracted load_and_validate_config() from run_node_blocking so the service main can call it during StartPending. - run_node_blocking now takes a pre-loaded Config rather than loading inside. - On validation failure, the service goes directly to Stopped with exit_code=1, never touching ServiceState::Running. Net effect: services.msc reflects the truth about whether the service got far enough to actually start. Operators triaging a "service won't start" issue see Stopped (not Running-then-crashed) and reach for the right diagnostics first. 147/147 unit tests still pass. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
X-API-Key→X-Node-API-Keyfor register/heartbeat in AGENTS.md outbound API table (verified againstsrc/api/client.rs)linux/arm64) are published on every release (verified against.github/workflows/release.yml)tracing-appenderfrom key dependencies table (not inCargo.toml)streaming.hlssection (segment_duration, playlist_size, bitrate) andmotionsection (enabled, threshold, cooldown_secs) — previously undocumented in the example configTest plan
X-Node-API-Keyheader matches all.header()calls insrc/api/client.rsconfig.example.yamlsections matchConfigstruct insrc/config/settings.rs.github/workflows/release.ymlbuild matrixhttps://claude.ai/code/session_01DdzBKawH6BhahW6BFiPsEW