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.

Sign up for GitHub

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

Jump to bottom

API documentation in README #16

Closed
4 of 5 tasks
Kurumiiw opened this issue Feb 17, 2023 · 1 comment · Fixed by #33
Closed
4 of 5 tasks

API documentation in README #16

Kurumiiw opened this issue Feb 17, 2023 · 1 comment · Fixed by #33
Labels
documentation infra infrastructure and project-wide issues
Milestone
Sprint 10

Comments

@Kurumiiw
Copy link
Owner

Kurumiiw commented Feb 17, 2023 •
edited by MollersThrane

Documentation of the API in the README file

Summary

Short summary of the issue.

Tasks

  • Architecture and how the middleware works
  • Technical description of the fragmentation header / proprietary information
  • Description of endpoints and what they do
  • Example code snippet
  • Configuration options and what they do / how it interacts with the underlying system.
@Kurumiiw Kurumiiw added infra infrastructure and project-wide issues documentation labels Feb 17, 2023
@Kurumiiw Kurumiiw added this to the Sprint 6 milestone Feb 17, 2023
@thorbjoernl thorbjoernl mentioned this issue Mar 10, 2023
Closed
2 tasks
@thorbjoernl thorbjoernl modified the milestones: Sprint 6, Sprint 10 Mar 17, 2023
olavfla added a commit that referenced this issue Mar 19, 2023
@olavfla
#16: Document API and some example code that needs to be tested on linux
e477c73
@thorbjoernl thorbjoernl mentioned this issue Mar 20, 2023
Merged
2 tasks
@thorbjoernl thorbjoernl linked a pull request Mar 20, 2023 that will close this issue
Draft: "Litt jalla" documentation #33
Merged
2 tasks
thorbjoernl pushed a commit that referenced this issue Mar 22, 2023
@olavfla @thorbjoernl
#16: Document API and some example code that needs to be tested on linux
d4c0f66
MollersThrane added a commit that referenced this issue Mar 22, 2023
@MollersThrane
#16 Wrote "litt jalla" system architecture doc
4da18d8
MollersThrane added a commit that referenced this issue Mar 22, 2023
@MollersThrane
#16 Rewrote "litt jalla" sentence
1d55b50
MollersThrane added a commit that referenced this issue Mar 22, 2023
@MollersThrane
#16 Removed test_from_doc.py
ac89a1e
@Soimn
Copy link
Collaborator

Soimn commented Mar 22, 2023

Regarding system architecture. The API is byte strem based for reliable connections, and message based for unreliable conections.

MollersThrane added a commit that referenced this issue Mar 23, 2023
@MollersThrane
#16 rewrote with only reliable using data stream
bd4e7ec
MollersThrane added a commit that referenced this issue Mar 23, 2023
@MollersThrane
#16 Some structural formatting changes
2749d91
MollersThrane added a commit that referenced this issue Mar 23, 2023
@MollersThrane
#16 fixed grammar errors
2cc0f5b
MollersThrane added a commit that referenced this issue Mar 23, 2023
@MollersThrane
#16 fixed "relaible"
cbe6009
thorbjoernl added a commit that referenced this issue Mar 23, 2023
@thorbjoernl @olavfla
@MollersThrane @Soimn
Draft: "Litt jalla" documentation (#33)
59d5ce2 
* #16: Document API and some example code that needs to be tested on linux

* Fix

* Update example snippets.

* Doc formatting.

* #16: Document API and some example code that needs to be tested on linux

* Fix

* Update example snippets.

* Doc formatting.

* Add docs on config options.

* Remove test_from_dock.py

* #16 Wrote "litt jalla" system architecture doc

* #16 Rewrote "litt jalla" sentence

* #16 Removed test_from_doc.py

* Fix typo + phrasing.

* Use known good TCP TOS field in test (See #34)

* changed MiddlewareAPI to MiddlewareReliable/-Unreliable, fixed examples, added docs for new methods, fixed config

* #16 rewrote with only reliable using data stream

* #16 Some structural formatting changes

* Add paragraph about example-service

* #16 fixed grammar errors

* #16 fixed "relaible"

---------

Co-authored-by: Ola Vanni Flaata <ola.flaata@gmail.com>
Co-authored-by: Tobias Thrane <Tobias@thrane.name>
Co-authored-by: Simon Doksrød <simon.doksrod@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation infra infrastructure and project-wide issues
Projects
None yet
Milestone
Sprint 10
Development

Successfully merging a pull request may close this issue.

Draft: "Litt jalla" documentation Kurumiiw/Middleware
3 participants
@Kurumiiw @Soimn @thorbjoernl