Docs: Quickstart test run + --via-ir optimizer example #16156
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.
This PR adds two small, newcomer-friendly docs improvements:
Contributing: a “Quickstart: build & run tests once” snippet so first-time contributors can verify their environment quickly.
Using the compiler: a minimal example showing solc --via-ir used with --optimize and --optimize-runs.
Files changed
docs/contributing.rst — quickstart test run block
docs/using-the-compiler.rst — --via-ir + optimizer example (--optimize-runs=1)
Why
New contributors often look for a single command to build & run tests, and many are unsure how --via-ir interacts with optimizer flags. These short, concrete snippets reduce setup friction and align with current usage.
Verification
Built docs locally with:
./docs/docs.sh
✅ Passed (no warnings/errors).
Scope
Docs-only. No changes to compiler code or behavior.
Notes for reviewers
Happy to adjust placement/wording if you prefer a different section heading or example contract.