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.

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

Already on GitHub? Sign in to your account

Markdown generator for the precompile docs #138

Merged
merged 4 commits into from Jan 5, 2024

Conversation

ferranbt
Copy link
Collaborator

@ferranbt ferranbt commented Jan 4, 2024

馃摑 Summary

This PR introduces a markdown generator for the precompiles. The suave-spec.yaml is extended with a description field for each precompile. It generates the same file in the suave-specs.

馃摎 References


  • I have seen and agree to CONTRIBUTING.md

@ferranbt ferranbt changed the title Generator for docs Markdown generator for the precompile docs Jan 4, 2024
## Precompiles Governance

The governance process for adding precompiles is in it's early stages but is as follows:
- Discuss the idea in a [forum post](https://collective.flashbots.net/)
Copy link
Contributor

Choose a reason for hiding this comment

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

perhaps link to suave forum directly https://collective.flashbots.net/c/suave/27

Copy link
Contributor

@metachris metachris left a comment

Choose a reason for hiding this comment

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

nice

@metachris
Copy link
Contributor

even better 馃憤

@ferranbt ferranbt merged commit 3ec0158 into main Jan 5, 2024
3 checks passed
@ferranbt ferranbt deleted the feature/docs-precompile-generator branch January 5, 2024 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants