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

CPX documentation #1020

Merged
merged 5 commits into from
Apr 19, 2022
Merged

CPX documentation #1020

merged 5 commits into from
Apr 19, 2022

Conversation

evoggy
Copy link
Member

@evoggy evoggy commented Apr 14, 2022

This documents the inner workings of CPX.

@evoggy
Copy link
Member Author

evoggy commented Apr 14, 2022

This is still work in progress, but I'll leave it here so we can have a look at it. It also contains some stuff that's not true yet, like CPX over CRTP. Let's see how this progresses otherwise we remove it 😄

Should we also add some information about the APIs at the end (like structs and C/Python APIs) or this should be in each of the repositories where this is implemented?

@krichardsson krichardsson marked this pull request as draft April 14, 2022 13:01
Copy link
Contributor

@krichardsson krichardsson left a comment

Choose a reason for hiding this comment

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

Looks good!

Ditaa is supported for repo docs if you want fancier diagrams https://www.bitcraze.io/development/contribute/repo-doc-guidelines/#diagrams

@evoggy
Copy link
Member Author

evoggy commented Apr 15, 2022

Nice, forgot about that! Updated the diagrams now to use ditaa instead.

The MTU of a packet which will not be split is still TDB. What about setting this to 30 bytes?

@evoggy
Copy link
Member Author

evoggy commented Apr 19, 2022

30 bytes was decided for the MTU.

@evoggy evoggy marked this pull request as ready for review April 19, 2022 14:16
@evoggy evoggy merged commit 29d81b7 into master Apr 19, 2022
@knmcguire knmcguire added this to the next release milestone May 10, 2022
@krichardsson krichardsson deleted the evoggy/cpx-doc branch May 10, 2022 11:10
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

3 participants