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

(WIP) chore: doc about network #157

Closed
wants to merge 2 commits into from

Conversation

xunilrj
Copy link

@xunilrj xunilrj commented Feb 23, 2023

This PR creates documentation about the network protocol.

The style is still confusing in the sense that is a mix of a code walk-through, reference documentation, and a tutorial. We can decide later which style to keep, or to split into multiple pages.

Closes #150

@xunilrj xunilrj marked this pull request as draft February 24, 2023 14:20
@philpax philpax self-assigned this Mar 6, 2023
@philpax
Copy link
Contributor

philpax commented Mar 6, 2023

Hey, super sorry about the time it's taken to look at this. It's been a busy two weeks.

Thanks for the contribution! We're trying to keep the documentation user-facing (that is, "developers building projects against Ambient"), so our preference is to not mention too much about the internals or how it's implemented.

Would you be able to revise this to discuss the user-facing experience (i.e. using the Networked attribute in ambient.toml), and to discuss the high-level points from the issue? The most important stuff is about the network architecture and its current limitations - e.g. no rollback, etc.

@philpax philpax closed this Mar 27, 2023
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.

Explain the network protocol and its current limitations
2 participants