Skip to content

Commit dc8dc53

Browse files
danceratopzemrhncvsglspencer-tb
authored
docs(consume): add consume command documentation (#1172)
* docs(consume): add consume command documentation (#1147) * docs(consume): re-structure pages into subsections * docs(fill): add an explanation of test ids * Apply suggestions from code review Co-authored-by: spencer <[email protected]> * docs(fill): minor improvements * fix(tooling),docs: fix markdownlint ul tab indent config * docs: fix copy-paste error * docs: claude's first consume attempt WIP * docs: improve top-level consume landing-page * docs(consume): write some docs * docs: refactor to 'running tests' WIP * docs: more running tests docs * docs: update changelog * docs: fix up nits from copilot review * docs: fix up nits from claue review * docs: fix typo * docs: fix typo --------- Co-authored-by: Emirhan Cavusoglu <[email protected]> Co-authored-by: spencer <[email protected]>
1 parent 2f66dcc commit dc8dc53

39 files changed

+1366
-216
lines changed

.markdownlint.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ MD034: false # no-bare-urls - We use pymdownx.magiclink which allows bare urls
55
MD046: false # code-block-style - This doesn't play well with material's admonitions)
66
MD024: false # no-duplicate-heading - We use duplicate headings in the changelog.
77
MD033: false # no-inline-html - Too strict.
8-
MD007:
8+
ul-indent:
99
indent: 4
10+
start_indent: 4

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ By default, JSON test fixtures are generated from this repository's Python test
161161

162162
## Usage
163163

164-
More information on how to obtain and consume the [released test fixtures](https://github.com/ethereum/execution-spec-tests/releases) can be found in the [documentation](https://eest.ethereum.org/main/consuming_tests/).
164+
More information on how to obtain and consume the [released test fixtures](https://github.com/ethereum/execution-spec-tests/releases) can be found in the [documentation](https://eest.ethereum.org/main/running_tests/).
165165

166166
For further help with working with this codebase, see the [online documentation](https://eest.ethereum.org/main/):
167167

docs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Users can select any of the artifacts depending on their testing needs for their
4747

4848
- ✨ Added the [EIP checklist template](https://eest.ethereum.org/main/writing_tests/checklist_templates/eip_testing_checklist_template/) that serves as a reference to achieve better coverage when implementing tests for new EIPs ([#1327](https://github.com/ethereum/execution-spec-tests/pull/1327)).
4949
- ✨ Added [Post-Mortems of Missed Test Scenarios](https://eest.ethereum.org/main/writing_tests/post_mortems/) to the documentation that serves as a reference list of all cases that were missed during the test implementation phase of a new EIP, and includes the steps taken in order to prevent similar test cases to be missed in the future ([#1327](https://github.com/ethereum/execution-spec-tests/pull/1327)).
50+
- ✨ Add documentation "Running Tests" that explains the different methods available to run EEST tests and reference guides for running `consume` and `hive`: ([#1172](https://github.com/ethereum/execution-spec-tests/pull/1172)).
5051
- ✨ Added a new `eest` sub-command, `eest info`, to easily print a cloned EEST repository's version and the versions of relevant tools, e.g., `python`, `uv` ([#1621](https://github.com/ethereum/execution-spec-tests/pull/1621)).
5152
- ✨ Add `CONTRIBUTING.md` for execution-spec-tests and improve coding standards documentation ([#1604](https://github.com/ethereum/execution-spec-tests/pull/1604)).
5253
- ✨ Use `codespell` instead of `pyspelling` to spell-check python and markdown sources ([#1715](https://github.com/ethereum/execution-spec-tests/pull/1715)).

docs/consuming_tests/index.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

docs/executing_tests/index.md

Lines changed: 0 additions & 125 deletions
This file was deleted.

docs/filling_tests/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The process of generating fixtures is often referred to as "filling" the tests.
99

1010
!!! note "The `execute` command"
1111

12-
The `execute` command directly executes Python test cases against a client via its RPC without using generated JSON fixtures. For all other methods of testing clients, the JSON fixtures are required. For more information, see [Executing Tests](../executing_tests/index.md).
12+
The `execute` command directly executes Python test cases against a client via its RPC without using generated JSON fixtures. For all other methods of testing clients, the JSON fixtures are required. For more information, see [Executing Tests](../running_tests/execute/index.md).
1313

1414
## Transition Tools (`t8n`)
1515

0 commit comments

Comments
 (0)