docs: fix AI-doc drift vs code#164
Merged
Merged
Conversation
- new-config: fail_on_bytecode_comparison_error defaults to true (not an opt-in 'strict mode'); document the rpc_url_env_var and deployment_gas_limit config keys that the code actually reads - debug-diff: BinVerifierError is caught in process_config and recorded as a non-match (match=False), it does not abort the run; quote the full 'Failed in binary comparison: ...' log line - CLAUDE.md: HTML diffs are saved under digest/<timestamp>/diffs/
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository AI guidance docs (CLAUDE.md and .claude/skills/*) to correct factual drift versus the current Diffyscan runtime behavior and output paths.
Changes:
- Corrected the HTML diff report output path documentation to the timestamped
digest/<timestamp>/diffs/layout. - Updated config documentation to reflect actual defaults and documented additional config keys used by the code (
rpc_url_env_var,deployment_gas_limit). - Clarified how bytecode comparison immutable-region mismatches surface (exception raised, but handled as a recorded non-match) and updated the user-visible error string.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CLAUDE.md |
Fixes documented location of generated HTML diff reports to match the timestamped digest structure. |
.claude/skills/new-config/SKILL.md |
Updates config option docs (defaults + newly documented keys). |
.claude/skills/debug-diff/SKILL.md |
Clarifies bytecode diff error handling behavior and updates the quoted log/error line. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Per Copilot review on #164: bytecode comparison errors are always caught and recorded as match=False; the flag actually controls whether a per-contract exception (e.g. explorer fetch/verify failure) aborts the run.
TheDZhon
approved these changes
Jun 2, 2026
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.
Audited the AI docs (
CLAUDE.md+.claude/skills/*) against the actual code and fixed the factual drift found. Docs were largely accurate; these are the real mismatches.Fixes
fail_on_bytecode_comparison_errorwas described as "set totruefor strict mode", buttrueis already the default (diffyscan.py); reworded to "defaults totrue; set tofalseto log instead of fail". Also documented two config keys the code reads but the skill omitted:rpc_url_env_varanddeployment_gas_limit.BinVerifierError" implied a fatal abort; clarified thatprocess_configcatches it and records a non-match (match=False). Also quoted the full user-visible log line (Failed in binary comparison: ...).digest/<timestamp>/diffs/.Not changed
validate-configandadd-explorerhad no real drift.solcInput+ContractNamecasing) is filed as zkSync explorer fetcher likely broken: missing solcInput (KeyError downstream) + ContractName casing mismatch #163 rather than fixed here.