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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new Specification (to be v0.7) document in outline form #342

Merged

Conversation

msgilligan
Copy link
Member

This is a draft outline/table-of-contents of the reformatted Omni Specification.

Some sections are very similar to sections in the original document, but there are changes to the order and some omission and additions. If there are any questions I can add more details to any sections. If there are any sections that you think are missing or that should be removed, please comment. Thanks!!

@dexX7
Copy link
Member

dexX7 commented Mar 31, 2020

Looks good, but in general, I think:

  1. Introducing what the OL is, how consensus is formed etc.
  2. Transaction parsing
  3. Payload and their effects

Having Class A as appendix seems the wrong way, because it's more like the first step to do.

@msgilligan
Copy link
Member Author

  1. Introducing what the OL is, how consensus is formed etc.

This would be section 2 (and also 3 and 4 for OMNI)

  1. Transaction parsing

Section 5 (and also 9)

  1. Payload and their effects

Section 6 (and also 8 and 9)

Having Class A as appendix seems the wrong way, because it's more like the first step to do.

Agreed. I moved it into the main body: 8e5ad04

I think that the majority of the people reading the specification will not be implementors, but people researching and evaluating Omni. I would like the order of presentation to be optimized for these readers. Since it is a technical specification, all the technical detail must be present and easily found via the table of contents, but should also be easy to skip over for those who want to understand how Omni works without studying all the implementation details.

@msgilligan msgilligan merged commit 8af386b into OmniLayer:master Apr 1, 2020
@msgilligan msgilligan deleted the msgilligan-revised-spec-outline branch April 1, 2020 20:03
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

4 participants