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

Layer 2 and Azimuth docs #1084

Merged
merged 45 commits into from
Nov 9, 2021
Merged

Layer 2 and Azimuth docs #1084

merged 45 commits into from
Nov 9, 2021

Conversation

drbeefsupreme
Copy link
Contributor

This draft PR will be used to add layer 2 documentation as it is written.

At the moment there are 2 new pages: /azimuth/layer2.md and
/azimuth/l2-actions.md.

layer2.md is a broad overview of how naive.hoon works intended for
developers. Some of it is about the aggregator, which will eventually be split
off into its own document. Yet to be added is an explanation of the byte format of
a L2 transaction and the form of a signed transaction. I am open to suggestions
for what else might be useful there.

l2-actions.md is a list of what L2 actions are available to each (rank, dominion)
tuple. This is complete, but there may be room for improvement in the
formatting.

Parts yet to be written in order of priority:

Bridge documentation intended for end-users
How to extract L2 PKI state tutorial
HTTP API documentation
Explainer for what all the different parts do and how data moves between them
How to set up an aggregator tutorial

I'm aiming to have the first two complete by the time L2 launches (though expect
to complete more). The HTTP API
documentation already mostly exists, its just not in a form suitable for
urbit.org. Same with the explainer on what all the different parts do.

@drbeefsupreme drbeefsupreme marked this pull request as draft August 26, 2021 19:23
Copy link
Contributor

@philipcmonk philipcmonk left a comment

Choose a reason for hiding this comment

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

This is great documentation. Some time we should write docs at a similar level for layer 1.

content/docs/azimuth/bytestring.md Outdated Show resolved Hide resolved
content/docs/azimuth/bytestring.md Outdated Show resolved Hide resolved
content/docs/azimuth/l2-actions.md Outdated Show resolved Hide resolved
content/docs/azimuth/layer2.md Outdated Show resolved Hide resolved
content/docs/azimuth/layer2.md Outdated Show resolved Hide resolved
content/docs/azimuth/layer2.md Outdated Show resolved Hide resolved
@drbeefsupreme
Copy link
Contributor Author

I've made the edits you asked @philipcmonk but won't be able to post the commit until later tonight when I'm at my own computer.

@drbeefsupreme drbeefsupreme changed the title Layer 2 docs Layer 2 and Azimuth docs Sep 15, 2021
@drbeefsupreme
Copy link
Contributor Author

As I write these docs its becoming more obvious that I should just explain Azimuth as a whole, including layer 1. l2-flow.md is the start of this. Since I don't know Solidity I don't know that I'll actually cover how the smart contracts work and will just focus on the Urbit side of things, but if I can scrape by with a really basic understanding then I'll try to do that as well.

Copy link
Collaborator

@tinnus-napbus tinnus-napbus left a comment

Choose a reason for hiding this comment

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

LGTM, just a few minor nits. Impressively comprehensive.

content/docs/azimuth/azimuth.md Outdated Show resolved Hide resolved
content/docs/azimuth/hd-wallet.md Outdated Show resolved Hide resolved
content/docs/azimuth/flow.md Outdated Show resolved Hide resolved
content/docs/azimuth/flow.md Outdated Show resolved Hide resolved
content/docs/azimuth/flow.md Outdated Show resolved Hide resolved
content/using/id/overview.md Outdated Show resolved Hide resolved
content/using/id/overview.md Outdated Show resolved Hide resolved
content/using/id/overview.md Outdated Show resolved Hide resolved
content/using/id/overview.md Outdated Show resolved Hide resolved
content/using/id/hd-wallet.md Outdated Show resolved Hide resolved
drbeefsupreme and others added 2 commits November 3, 2021 12:38
Co-authored-by: tinnus-napbus <77721746+tinnus-napbus@users.noreply.github.com>
Co-authored-by: tinnus-napbus <77721746+tinnus-napbus@users.noreply.github.com>
@drbeefsupreme
Copy link
Contributor Author

This PR is ready to be merged.

I removed the link to @yosoyubik 's roller API docs since they're out of date. We can add them back in at a later date once he updates them. 48558a5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants