Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(consume): add consume command documentation #1147

Merged
merged 1 commit into from
Jan 29, 2025
Merged

docs(consume): add consume command documentation #1147

merged 1 commit into from
Jan 29, 2025

Conversation

emrhncvsgl
Copy link
Contributor

@emrhncvsgl emrhncvsgl commented Jan 29, 2025 •
edited by danceratopz
Loading

🗒️ Description

Added documentation for the consume command in the "Consuming Tests" section. This documentation includes:

  • What is consume and its purpose
  • When to use it
  • How to use it with different methods (direct, engine, hive, rlp)
  • Examples and Hive considerations (including --dev mode and --client-config flag)

🔗 Related Issues

Fixes #1125

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.

@emrhncvsgl
Copy link
Contributor Author

it might be a little verbose also should I add latest-stable-release and latest-develop-release options in consume.

@danceratopz danceratopz added scope:docs Scope: Documentation scope:consume Scope: Consume command suite labels Jan 29, 2025
@danceratopz danceratopz changed the title (docs): add consume command documentation docs(consume): add consume command documentation Jan 29, 2025
@danceratopz danceratopz changed the base branch from main to consume-docs January 29, 2025 13:04
danceratopz
danceratopz approved these changes Jan 29, 2025
View reviewed changes
Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks a lot for this 🙂 It'll need a couple of improvements to handle a couple of limitations/nuances and we should expand the hive section.

I changed the target base branch to a consume-docs feature branch were we can work further on this, if you like, if not I'm happy to bring it to completion.

@Emirhan-Cavusoglu-sftw, happy to collab on this if you want, but if you'd like another task we can also find something else for you. Feel free to reach out to me via discord/telegram or the Ethereum R&D discord, see https://ethereum.github.io/execution-spec-tests/main/getting_started/getting_help/

@danceratopz danceratopz merged commit a96773c into ethereum:consume-docs Jan 29, 2025
1 check passed
@danceratopz danceratopz mentioned this pull request Feb 4, 2025
Draft
4 tasks
danceratopz pushed a commit that referenced this pull request Feb 5, 2025
@emrhncvsgl @danceratopz
docs(consume): add consume command documentation (#1147)
43960d2
danceratopz pushed a commit that referenced this pull request Feb 5, 2025
@emrhncvsgl @danceratopz
docs(consume): add consume command documentation (#1147)
07c02ce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danceratopz danceratopz danceratopz approved these changes

Assignees
No one assigned
Labels
scope:consume Scope: Consume command suite scope:docs Scope: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve documentation on consume
2 participants
@emrhncvsgl @danceratopz