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

Update "Design & impl" section in book. #906

Open
Urhengulas opened this issue Dec 2, 2024 · 2 comments
Open

Update "Design & impl" section in book. #906

Urhengulas opened this issue Dec 2, 2024 · 2 comments
Labels
good first issue Good for newcomers type: documentation Fixes, improvements or additions to the documentation

Comments

@Urhengulas
Copy link
Member

Urhengulas commented Dec 2, 2024 •
edited
Loading

The section is out of date in many parts. It should be revisited to make sure it reflects the current design and implementation.

https://defmt.ferrous-systems.com/design

For the moment it would be good to add a header to every page which warns about it being potentially outdated. Maybe > ⚠️ The design and implementation chapter is outdated ⚠️.
@Urhengulas Urhengulas mentioned this issue Dec 2, 2024
Closed
@Urhengulas Urhengulas added the good first issue Good for newcomers label Dec 2, 2024
@BenFordTytherington
Copy link
Contributor

BenFordTytherington commented Dec 6, 2024 •
edited
Loading

Warnings added in #912

@BenFordTytherington BenFordTytherington mentioned this issue Dec 6, 2024
Merged
@Urhengulas Urhengulas added the type: documentation Fixes, improvements or additions to the documentation label Dec 18, 2024
@jonathanpallant
Copy link
Contributor

OK, now we have the warnings, we really need to go through and update the book and remove the warnings :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers type: documentation Fixes, improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jonathanpallant @Urhengulas @BenFordTytherington