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

feat(docs): Add section on CoAP #448

Merged
merged 3 commits into from
Oct 24, 2024

Conversation

chrysn
Copy link
Collaborator

@chrysn chrysn commented Sep 27, 2024

Description

As per today's meeting, I've pulled ahead writing CoAP documentation to give all involved a better overview of how the security protocols interact.

Unlike what we otherwise do with the book, this is ahead of the implementation (covering some of the roadmap but also some things not in there in the current iteration). As this matures, the annotation of "we don't have this yet" will move from page-wide into sections.

Open questions

Should we aim for this to be merged with the disclaimer in, or do we rather keep it as a PR until most of it is implemented? I'm leaning toward the former, especially because the book is also a good reference for developers.

Change checklist

  • I have cleaned up my commit history and squashed fixup commits.
  • I have followed the Coding Conventions.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.

@chrysn chrysn mentioned this pull request Sep 27, 2024
book/src/tooling/coap.md Outdated Show resolved Hide resolved
@ROMemories ROMemories self-requested a review September 30, 2024 09:41
book/src/tooling/coap.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@elenaf9 elenaf9 left a comment

Choose a reason for hiding this comment

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

Great chapter!

book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
@chrysn
Copy link
Collaborator Author

chrysn commented Oct 3, 2024

Thanks, good points, all addressed. I've left the non-trivial ones unresolved (except the one I opened myself).

While most fixups are precise (thanks to git absorb), I think this can be squashed into a single commit when accepted.

@chrysn chrysn marked this pull request as ready for review October 4, 2024 14:32
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
@chrysn chrysn force-pushed the coap-book branch 2 times, most recently from fe1b31b to d180b74 Compare October 9, 2024 13:07
Copy link
Collaborator

@kaspar030 kaspar030 left a comment

Choose a reason for hiding this comment

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

I really want the OSCORE/EDHOC/ACE stack optional.

if we manage to fully tame the added complexity, this can be changed down the line, but initially just to make that complexity visible, it has to be optional.

book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Show resolved Hide resolved
chrysn added a commit to chrysn-pull-requests/RIOT-rs that referenced this pull request Oct 16, 2024
chrysn added a commit to chrysn-pull-requests/RIOT-rs that referenced this pull request Oct 16, 2024
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
book/src/tooling/coap.md Outdated Show resolved Hide resolved
@kaspar030
Copy link
Collaborator

I much prefer this restructured version!

@chrysn
Copy link
Collaborator Author

chrysn commented Oct 24, 2024

I've done an editing pass fixing some remaining typos, grammer errors or inconsistencies (finally found a better subsection title, s/ACE during development/Using ACE from the host during development/ is now consistent with the earlier heading "Interacting with a RIOT-rs CoAP server from the host"), and applied fixes that got lost over non-git contributions.

@kaspar030, if you're fine with this and can press the button, I'll squash.

@kaspar030
Copy link
Collaborator

@kaspar030, if you're fine with this and can press the button, I'll squash.

let's go!

@kaspar030
Copy link
Collaborator

Feel free to "gq" the paragraphs to a consistent look ...

chrysn and others added 3 commits October 24, 2024 15:21
Co-authored-by: ROMemories <152802150+ROMemories@users.noreply.github.com>
Co-authored-by: Kaspar Schleiser <kaspar@schleiser.de>
@chrysn
Copy link
Collaborator Author

chrysn commented Oct 24, 2024

I'm not sure we have an official style guide – I've squashed things rather broadly because the different kinds of edits didn't commute well, now it's "create, restructure, editorial fixes". This captures the genesis without being spread too thin into "fix(doc/coap): Typos".

Hope that's fine.

@chrysn
Copy link
Collaborator Author

chrysn commented Oct 24, 2024

Feel free to "gq" the paragraphs to a consistent look ...

I expect to review later edits on those, so I'd prefer not to; https://sembr.org/ says it better than I can.

@kaspar030 kaspar030 added this pull request to the merge queue Oct 24, 2024
Merged via the queue into future-proof-iot:main with commit 90d2217 Oct 24, 2024
25 checks passed
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.

6 participants