stone: Extend the documentation about headers#104
Draft
livingsilver94 wants to merge 2 commits intoAerynOS:mainfrom
Draft
stone: Extend the documentation about headers#104livingsilver94 wants to merge 2 commits intoAerynOS:mainfrom
livingsilver94 wants to merge 2 commits intoAerynOS:mainfrom
Conversation
622d596 to
9c0dea4
Compare
9c0dea4 to
81edeaa
Compare
Member
Author
|
We have added Mermaid support in this repo. I'm setting the Draft mode, I may choose to use Mermaid. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a small PR that tries to improve the documentation about the global header of a stone.
I plan to further document the Stone format by adding pages about the payloads, but for now I'll stop with the header.
And since I can't help adding unsolicited edits, I thought that "Prelude" is a better name for the global header. In fact, there are three kinds of header in a stone:
datasection of the agnostic header, version-dependentI think there are too many name clashes, hence my choice to introduce the name "Prelude" to uniquely identify the global header, version-agnostic.
I'm still not sure if we should call the version-dependent header e.g. "V1 prelude" or not.
The name "Prelude" comes from Rust's prelude.