Skip to content

docs: document active/evm structure in root README - #776

Merged
0xth4nh merged 1 commit into
mainfrom
mux/active-evm-docs
Jul 30, 2026
Merged

docs: document active/evm structure in root README#776
0xth4nh merged 1 commit into
mainfrom
mux/active-evm-docs

Conversation

@0xth4nh

@0xth4nh 0xth4nh commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

What changed?

Updates the root README.md to document the shared active/evm model, layered on top of the existing docs (existing sections and their logic are preserved):

  • Directory structure: leads with the current active/evm layout — one shared active/evm/Makefile (selects the task via TASK_ID / TASK_NETWORK), shared foundry.toml + script/common/<category>/, and per-task config/<network>/ with validations/; task-origin signatures live outside the signed config dir at tasks/<task-id>/signatures/<network>/. Legacy per-task layout kept as a subsection afterward.
  • CI section: updated to describe the validate-common-scripts workflow (the old validate-templates workflow it documented was removed).
  • Task origin signing: notes how active/evm tasks set TASK_ORIGIN_DIR (the signed config/<network> dir) and SIGNATURE_DIR (signatures stored outside it), plus the skipTaskOriginValidation opt-out.
  • Documents installing deps for the shared project via make deps PROJECT_DIR="$PWD/active/evm".

Scope is a single file: root README.md. No separate active/evm/README.md / TASK_ORIGIN.md — the root README is the single source of truth for structure and signing, matching how tasks (which carry only a per-task README + FACILITATOR) are documented. Stacked on #775 (CI, merged).

Why?

The root README still described the old per-task-project structure and the removed template-validation CI. This aligns it with the shared active/evm model and the current CI.

How to test?

Docs only — no build impact. Verify the rendered layout matches the actual active/evm tree (one active/evm/Makefile; signatures under tasks/<id>/signatures/<network>) and that the referenced make targets exist in the root Makefile (sign-as-*) and the task Makefile (gen-validation-*).

@0xth4nh
0xth4nh force-pushed the mux/ci-validate-common branch from ce69c3a to 5367a22 Compare July 29, 2026 22:16
@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from 3cddd0b to ff4f9b4 Compare July 29, 2026 22:17
@0xth4nh
0xth4nh force-pushed the mux/ci-validate-common branch from 5367a22 to 035093b Compare July 29, 2026 22:19
@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from ff4f9b4 to 92134fa Compare July 29, 2026 22:20
Base automatically changed from mux/ci-validate-common to main July 29, 2026 22:55
@cb-heimdall

cb-heimdall commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

✅ Heimdall Review Status

Requirement Status More Info
Reviews 2/2
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 2
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 2
2
1 if commit is unverified 0
Sum 2

@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from 92134fa to 632ea21 Compare July 29, 2026 22:59
jackchuma
jackchuma previously approved these changes Jul 29, 2026
@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from 632ea21 to d687b3c Compare July 29, 2026 23:05
@cb-heimdall
cb-heimdall dismissed jackchuma’s stale review July 29, 2026 23:05

Approved review 4813619797 from jackchuma is now dismissed due to new commit. Re-request for approval.

@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from d687b3c to b6be58b Compare July 29, 2026 23:12
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from b6be58b to a79501f Compare July 30, 2026 14:41
@0xth4nh 0xth4nh changed the title docs(active-evm): add README and task-origin signing guide docs: document active/evm structure in root README Jul 30, 2026
Comment thread README.md Outdated
Documents the shared active/evm layout (script/common + per-task config),
the shared-project deps invocation, and active/evm task-origin signature
handling in the root README, alongside the existing legacy-task docs. Also
updates the CI section to describe the validate-common-scripts workflow.

No separate active/evm README/TASK_ORIGIN files: the root README is the
single source of truth for structure and signing, matching how tasks (which
carry only a per-task README + FACILITATOR) are documented.

Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@0xth4nh
0xth4nh force-pushed the mux/active-evm-docs branch from a79501f to c441880 Compare July 30, 2026 15:11
@0xth4nh
0xth4nh merged commit fc28503 into main Jul 30, 2026
5 checks passed
@0xth4nh
0xth4nh deleted the mux/active-evm-docs branch July 30, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants