PoC: schema-driven doc-sync engine (3/70, tracks #1987)#1989
Draft
Th0rgal wants to merge 1 commit into
Draft
Conversation
Adds step 1 of the schema-driven consolidation effort: - scripts/CONSOLIDATION_INVENTORY.md: table of all 63 check_*.py / generate_*.py scripts (53 + 10), clustered into 9 families with per-cluster counts and source-of-truth / assertion columns. Includes verification section showing prototype parity. - scripts/consolidation_schema.md: declarative YAML schema for a generic 'sync rule' (id, extractor, output_format, target, json_options). Maps 4 representative scripts onto the schema and outlines a 5-phase migration path. - scripts/sync_engine.py: working prototype engine that loads rules from YAML, calls the declared Python extractor, serialises the result, and writes or diffs the target file (--check mode). - scripts/rules/docsync.yaml: 3 rules reproducing generate_verify_sync_spec.py, generate_layer2_boundary_catalog.py, and generate_verification_status.py. All three produce byte-for-byte identical output to the originals (verified with diff). No originals deleted or modified.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
| \n### CI Failure Hints\n\nFailed jobs: `checks`\n\nCopy-paste local triage:\n```bash\nmake check\nlake build\nFOUNDRY_PROFILE=difftest forge test -vv\n``` |
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.
Draft / proof-of-concept — split out of #1971 to keep that PR focused.
Adds a schema-driven
scripts/sync_engine.py+scripts/rules/docsync.yaml+ design docs, reproducing 3 of ~70check_*.py/generate_*.pyscripts byte-for-byte.Not yet usable as a replacement — the engine must subsume all 70 and the legacy scripts must be deleted with CI switched over. Completion plan tracked in #1987.
Base is the #1971 branch (not
main) so the diff shows only the engine. Retarget tomainonce #1971 merges.