docs: expand architecture.md to cover all 20 crates#14830
Open
0xAxiom wants to merge 1 commit into
Open
Conversation
Closes foundry-rs#13880 The previous architecture.md documented only 3 crates (evm, config, cli). This extends it to cover all 20 crates currently in the repo, grouped by role: - Binaries: forge, cast, anvil, chisel - Core Libraries: evm, cheatcodes, config, common, primitives - CLI & TUI: cli, cli-markdown, debugger - Compilation & Formatting: fmt, lint, doc, linking, sol-macro-gen - Scripting & Deployment: script, script-sequence, verify - Testing & Internal Utilities: macros, test-utils Descriptions sourced from Cargo.toml, lib.rs doc comments, and crate READMEs.
0xAxiom
requested review from
0xrusowsky,
DaniPopes,
figtracer,
grandizzy,
mablr,
mattsse,
stevencartavia and
zerosnacks
as code owners
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.
Closes #13880
What
The previous
docs/dev/architecture.mddocumented only 3 crates (evm/,config/,cli/). This PR extends it to cover all 20 crates currently incrates/, grouped by role:forge,cast,anvil,chiselevm,cheatcodes,config,common,primitivescli,cli-markdown,debuggerfmt,lint,doc,linking,sol-macro-genscript,script-sequence,verifymacros,test-utilsWhy
Issue #13880 called out that the majority of crates had no architectural documentation. Descriptions were sourced from each crate's
Cargo.tomldescriptionfield,lib.rsdoc comment, and/orREADME.md.Existing entries (
evm/,config/,cli/) are preserved and lightly expanded. No code changes.