메뉴
Analyzes a PR diff to determine if documentation under docs/ needs updating. Use when a PR modifies EVM behavior, gas constants, system contracts, opcode semantics, resource limits, or spec definitions in mega-evm source code.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Bumps the workspace version in Cargo.toml and Cargo.lock, creates a version bump PR, waits for CI, and creates a GitHub release with auto-generated notes. Use when releasing a new version, bumping version, creating a release, tagging a release, or running a release workflow.
Verifies documentation claims in docs/ against implementation source code in this repository. Use when cross-checking doc accuracy, auditing constants and addresses, verifying spec correctness, or validating behavioral rules against source.
Detects recent code changes in mega-evm that are not yet reflected in docs/. Use when checking for documentation gaps, auditing doc coverage after a release, looking for undocumented changes, or running a periodic doc sweep.
Evaluates documentation readability, structure, and compliance with docs/spec/AGENTS.md conventions. Use when reviewing doc quality, auditing formatting compliance, checking a page before publishing, or running a readability audit across the specification.
| name | doc-impact-check |
| description | Analyzes a PR diff to determine if documentation under docs/ needs updating. Use when a PR modifies EVM behavior, gas constants, system contracts, opcode semantics, resource limits, or spec definitions in mega-evm source code. |
Analyze the current PR diff to determine whether documentation under docs/ needs updating.
This skill runs in CI on pull requests that modify source code under crates/mega-evm/src/, crates/system-contracts/, or bin/mega-evme/src/.
It checks whether the code changes affect documented behavior and whether the PR already includes corresponding doc updates.
The documentation in docs/ is the formal MegaETH specification.
Read docs/spec/AGENTS.md for the writing rules and conventions.
Use this mapping to identify which doc pages are potentially affected by code changes.
| Code path | What changes here | Affected doc pages |
|---|---|---|
crates/mega-evm/src/constants.rs | Gas limits, resource limits, detention caps, multipliers | docs/spec/evm/dual-gas-model.md, docs/spec/evm/resource-limits.md, docs/spec/evm/gas-detention.md, docs/spec/evm/gas-forwarding.md, docs/spec/evm/contract-limits.md |
crates/mega-evm/src/evm/spec.rs | Spec definitions, spec progression | docs/spec/hardfork-spec.md, docs/spec/upgrades/overview.md, docs/spec/evm/overview.md |
crates/mega-evm/src/evm/instructions.rs | Opcode behavior, compute gas wrapping, gas detention enforcement | docs/spec/evm/dual-gas-model.md, docs/spec/evm/gas-detention.md |
crates/mega-evm/src/evm/host.rs | Host hooks, volatile data access tracking | docs/spec/evm/gas-detention.md |
crates/mega-evm/src/evm/precompiles.rs | Precompile behavior | docs/spec/evm/precompiles.md |
crates/mega-evm/src/block/ | Block execution, hardfork mapping, executor | docs/spec/hardfork-spec.md, docs/spec/evm/overview.md |
crates/mega-evm/src/limit/ | Resource limit tracking (compute gas, data size, KV updates, state growth) | docs/spec/evm/resource-limits.md, docs/spec/evm/resource-accounting.md |
crates/mega-evm/src/limit/storage_call_stipend.rs | Storage gas stipend lifecycle | docs/spec/evm/gas-forwarding.md |
crates/mega-evm/src/access/ | Block env access tracking, volatile data detection | docs/spec/evm/gas-detention.md |
crates/mega-evm/src/system/ | System contract integration, call interception | docs/spec/system-contracts/*.md |
crates/mega-evm/src/external/ | SALT environment, oracle environment, dynamic gas cost | docs/spec/evm/dual-gas-model.md, docs/spec/system-contracts/oracle.md |
crates/system-contracts/contracts/ | Solidity system contract sources | docs/spec/system-contracts/*.md |
bin/mega-evme/src/cmd.rs | CLI command dispatch, top-level commands | docs/mega-evme/overview.md |
bin/mega-evme/src/run/ | Bytecode execution command | docs/mega-evme/commands/run.md |
bin/mega-evme/src/tx/ | Transaction execution command | docs/mega-evme/commands/tx.md |
bin/mega-evme/src/replay/ | Historical transaction replay | docs/mega-evme/commands/replay.md |
bin/mega-evme/src/common/ | Shared CLI args, state loading, tracing, tx parsing | docs/mega-evme/configuration/*.md, docs/mega-evme/tracing/*.md |
Code changes can also make agent instruction files stale. These files contain code paths, constant names, system contract tables, and spec references that must stay in sync with the implementation.
| Code path | Affected agent files |
|---|---|
crates/mega-evm/src/evm/spec.rs | AGENTS.md (spec progression list, unstable spec marker), CLAUDE.md (same content) |
crates/mega-evm/src/block/hardfork.rs | AGENTS.md (hardfork-to-spec mapping) |
crates/mega-evm/src/ (new/renamed modules) | AGENTS.md (Core Source Layout section) |
crates/system-contracts/contracts/ (new contract) | AGENTS.md (System Contracts table) |
crates/mega-evm/src/constants.rs | AGENTS.md (Key Concepts sections referencing constant names) |
crates/mega-evm/src/system/ | AGENTS.md (System Contracts section), .claude/skills/doc-impact-check/SKILL.md and .claude/skills/doc-freshness/SKILL.md (code-to-doc mapping tables) |
crates/mega-evm/src/limit/ (new tracker) | AGENTS.md (Multidimensional Resource Limits section) |
bin/mega-evme/src/ (new/renamed modules) | bin/mega-evme/AGENTS.md (STRUCTURE section) |
docs/ (new pages added to SUMMARY.md) | .claude/skills/doc-impact-check/SKILL.md and .claude/skills/doc-freshness/SKILL.md (code-to-doc mapping tables need new entries) |
gh pr diff $PR_NUMBER
Identify all changed files and classify each as:
docs/. Note which pages are updated.Focus on behavioral code changes only.
For each behavioral code change:
AGENTS.md, CLAUDE.md, or skill files.Check if the PR already includes changes to the affected doc pages:
Post a single PR comment with findings.
If doc or agent file updates are needed:
## Documentation Impact
This PR modifies EVM behavior that is documented in `docs/` or referenced in agent files. The following files may need updating:
### Spec Documentation
| Doc page | Reason |
|----------|--------|
| `docs/spec/evm/dual-gas-model.md` | {what changed and why the page is affected} |
| `docs/spec/evm/resource-limits.md` | {what changed and why the page is affected} |
{If the PR introduces a new spec}: A new upgrade page under `docs/spec/upgrades/` is also needed.
### Agent / Skill Files
| File | Reason |
|------|--------|
| `AGENTS.md` | {e.g., spec progression list needs new spec, system contract table needs new entry} |
These updates can be included in this PR or in a follow-up.
If no doc updates are needed:
Do NOT post a comment. Only comment when there is an actionable finding.
If the PR already includes correct doc updates:
Do NOT post a comment. The PR review job handles general review.
COMPUTE_GAS_LIMIT changed from 1,000,000,000 to 2,000,000,000 — update the Constants table in docs/spec/evm/resource-limits.md" is actionable.docs/spec/upgrades/.pr-review job. Focus exclusively on doc impact.