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: add a section on using fixtures & est releases #334

Merged
merged 6 commits into from
Oct 19, 2023
Merged

docs: add a section on using fixtures & est releases #334

merged 6 commits into from
Oct 19, 2023

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Oct 16, 2023 •
edited
Loading

🗒️ Description

  • Adds a section describing how to use and retrieve execution-spec-tests release artifacts.
  • Fix Github Actions by fixing a new deprecation warning due to package upgrade, more info 7e9ff74.

Preview available here:
https://danceratopz.github.io/execution-spec-tests/docs-only/getting_started/using_fixtures/

🔗 Related Issues

None.

✅ 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.
  • Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added scope:docs Scope: Documentation type:chore Type: Chore labels Oct 16, 2023
@danceratopz
docs: update changelog
fc52610
@danceratopz
docs: improve using fixtures section and add cross-links
5650e33
@danceratopz
fix(docs): fix warning in mkdocs build for emoji package changes
7e9ff74 
This fixes the following warning:
```
WARNING -  Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.to_svg'
           as mkdocs_material_extensions is deprecated and will no longer be
           supported moving forward. This is the last release.
```
@danceratopz
chore: clean up whitespace in mkdocs.yml config file
c18cae8
spencer-tb
spencer-tb approved these changes Oct 18, 2023
View reviewed changes
Copy link
Collaborator

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

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

Really nice, and reads well! For me it makes sense to remove the forks below so we don't need to update them in the future but happy to keep them :D

@danceratopz @spencer-tb
Update docs/getting_started/using_fixtures.md
e9bd514 
Co-authored-by: spencer <spencer.taylor-brown@ethereum.org>
@spencer-tb spencer-tb mentioned this pull request Oct 19, 2023
Closed
6 tasks
@spencer-tb spencer-tb merged commit f94de0e into ethereum:main Oct 19, 2023
@danceratopz danceratopz deleted the docs/using-and-getting-releases branch October 20, 2023 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marioevz marioevz marioevz approved these changes

@spencer-tb spencer-tb spencer-tb approved these changes

Assignees
No one assigned
Labels
scope:docs Scope: Documentation type:chore Type: Chore
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@danceratopz @marioevz @spencer-tb