This repository was archived by the owner on May 12, 2025. It is now read-only.
Add draft of Metaspec. #82
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Here's a quick render to show you what it looks like 
|
|
Addendum: this is a quick-and-dirty draft aimed to get something out the door. It's probably a good idea to explicitly define each state in the lifecycle and list the corresponding criteria. I can do that in a separate PR -- just want to get early feedback before going too deep. |
metachris
reviewed
Mar 18, 2024
Comment on lines
+35
to
+37
| - name: Louis Thibault | ||
| email: louis@flashbots.net | ||
| github: lthibault |
There was a problem hiding this comment.
perhaps better anonymized
|
I see it's adding a could also link ethereum specs as inspiration. |
|
(whoops sorry, misclicked and closed by accident) |
andytudhope
reviewed
Mar 18, 2024
|
|
||
| ### Frontmatter | ||
|
|
||
| A spec must being with frontmatter. Frontmatter is a preamble to the document, is delimited with `---`, and contains YAML data. The frontmatter for the present spec is as follows: |
|
|
||
| A spec MUST have exactly one title, which is to say an h1 heading. The title MUST appear at the top of the Markdown document. | ||
|
|
||
| Sections in a spec are nested by using various heading depths. For the avoidance of doubt, "section" SHALL refer to any hn>1 heading, to distinguish it from the title. Content between the title and the first section of a document is considered to be the abstract for the document. Rendering pipelines SHOULD incorporated the abstract into the header content. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Metaspec is a specification for SUAVE specifications. It aims to add Just Enough (TM) structure to our prose to facilitate automated conformance testing and rendering pipelines in the future.
This is the first step in my effort to overhaul our specs, and feedback is warmly welcomed.