docs(capture): update stale configuration reference - #1516
Open
kpr (KPR111) wants to merge 1 commit into
Open
kpr (KPR111) wants to merge 1 commit into
kpr (KPR111) wants to merge 1 commit into
Conversation
…E.md Review the capture configuration reference against the current Pydantic models and schema tooling, and correct the content that had drifted. - Correct the RecordingConfig import path from the non-existent src.common.config_models to models.config_models, in both the runtime example and the schema-generation description - Fix the schema regeneration command: it must run from the repository root because generate_config_schema.py writes to a root-relative path, and the documented 'PYTHONPATH=. python config/generate_config_schema.py' wrote the schema to a nested path instead - Document output_dir, which is defined on RecordingConfig and present in recording_config.yaml but was absent from the reference, including its absolute/exists/is-a-directory/is-writable validation rules - Add a top-level field table clarifying that only topics and trigger are required, and that extra keys are rejected via extra: forbid - Remove the 'frequency_hz out of range' validation row; no such message exists in the models. Range and enum violations surface Pydantic's standard constraint messages instead - Replace the broken ../docs/inference/lerobot-inference.md link, which resolves to no file in the repository - Repair the mojibake in the Schema Maintenance heading and drop an empty txt code fence - Link the CI schema drift check to validate-config-schema.yml - Refresh ms.date per the documentation freshness policy Verified with markdownlint-cli2 and cspell (both clean). All nine relative links in the file now resolve; previously one did not. Refs microsoft#1420 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
kpr (@KPR111) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
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
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
Correct the stale content in
data-pipeline/capture/config/README.md, flagged by the documentation freshness automation (#1420). The reference had drifted from the current Pydantic models and schema tooling.RecordingConfigimport path —src.common.config_modelsdoes not exist; the module ismodels.config_models. Corrected in both the runtime example and the schema-generation description.generate_config_schema.pywrites to a repository-root-relative path, so it must be run from the root. The previously documentedPYTHONPATH=. python config/generate_config_schema.pywrote the schema to a nested path instead.output_dir, which is defined onRecordingConfigand set inrecording_config.yamlbut was absent from the reference, including its absolute / exists / is-a-directory / is-writable validation rules.topicsandtriggerare required, and that unknown keys are rejected viaextra: "forbid".frequency_hz out of rangevalidation row — no such message exists in the models. Range and enum violations surface Pydantic's standard constraint messages instead.../docs/inference/lerobot-inference.mdlink, which resolves to no file in the repository.validate-config-schema.yml.ms.dateper the documentation freshness policy.Scope
Documentation only. One file changed, no code, schema, or configuration changes.
Validation
markdownlint-cli2cleancspellcleanCloses #1420
🤖 Generated with Claude Code