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

[After TMM] Revise protocol documentation #482

Open
Askaholic opened this issue Jul 28, 2019 · 4 comments
Open

[After TMM] Revise protocol documentation #482

Askaholic opened this issue Jul 28, 2019 · 4 comments

Comments

@Askaholic
Copy link
Collaborator

We really need a dedicated server protocol document where we write down what messages are sent by the client, and what responses come from the server. That way the client developers can have something to reference without needing to read the server code. This would also push us toward defined protocol versions where we can explicitly say "version 1.0 has exactly these commands".

Ideally we would refactor the server so that much of this documentation could be generated automatically from doc strings.

@cleborys cleborys self-assigned this Mar 7, 2020
@cleborys cleborys linked a pull request Mar 7, 2020 that will close this issue
@cleborys cleborys changed the title Revise protocol documentation [After TMM] Revise protocol documentation Mar 15, 2020
Askaholic added a commit that referenced this issue Apr 23, 2021
* Add doc link to readme

* Run server doctests with pytest

* Use lazy args in log call

* Add top level docstrings and rewrite existing ones to use markdown

* Remove server.abc module

* Add overview to main page
@KaukaHan
Copy link
Contributor

how about implementing the hole protocol into a webassembly module, witch can be shared between the server and client ?

@Askaholic
Copy link
Collaborator Author

I’m not sure how that would work. Can you elaborate?

@Sheikah45
Copy link
Member

I am always surprised a little that the protocol was never defined in a third repo using like Google protobuf that allows it to be cross language

@KaukaHan
Copy link
Contributor

https://webassembly.org/
https://wasmer.io/
tldr: webassembly and wasmer would allow to compile into a platform indepenent, efficient, sandboxed, binary format witch can be embed into other software. the biggest problem i think is, you need a compiled language to compile into wasm, like c/c++ or rust. might be overkill therefor.

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

Successfully merging a pull request may close this issue.

4 participants