Repository navigation
Document YAML configuration schemas and guard against schema drift - #18
Merged
Merged
Conversation
|
Preview closed This PR is closed and its preview has been removed. |
This branch was successfully deployed
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
1 participant
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.
The configuration guide did not list complete schemas, so readers had to search narrative sections or the validators to find supported fields and defaults. Put field tables and executable examples first for eval sets, weights, catalogue manifests, per-eval rules, normalization, components, languages, portable catalogues, and startup selections. Every field lists its required/optional status, type, allowed values, and omission behavior; existing scoring explanations remain below the reference.
Add CI checks that compare the documented field inventories and unconditional requirements with the live Python validators, load the filesystem examples, and validate the labelled configuration examples through both scoring engines. Stable invisible labels allow prose and sections to move without snapshot tests. Conditional semantics and explanatory prose still require the existing behavioral tests and review.
Validation:
python3 -m tests.checkpasses, including Python, Node, and Chrome. All 12 YAML examples and 60 local documentation links/anchors were also checked. No scoring or API behavior changes.