Skip to content

Update example execution images in the README #175

@kehoecj

Description

@kehoecj

We currently use images to show example validator runs. These don't look great and since they are from the maintainer's desktop it makes it difficult for contributors to update the README with a new example.

Example:

image

Rather than images from a computer it would be nice to have a standard tool that all contributors could use to generate the examples. Terminalizer or equivalent could work but I think I'd prefer the images be static rather than gif - could be convinced otherwise though. Scope of this story would be to recommend a tool, get approval from the maintainers, then implement it for the README.md and Index.md pages. The final step would be adding the instructions for generating the image - including required settings so they look exactly the same - on the CONTRIBUTING.md page.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershacktoberfest 🎃Hacktoberfest 2024has-prThis issue has an associated PRhelp wantedExtra attention is neededno codeIssues that do not require a coding solution

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions