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 the book #921

Merged
merged 9 commits into from
Jan 27, 2025
Merged

Update the book #921

merged 9 commits into from
Jan 27, 2025

Conversation

jonathanpallant
Copy link
Contributor

  • Added info about the different packages
  • Added info about the different Defmt Versions

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jan 20, 2025 •
edited
Loading

Deploying knurling-defmt-book with  Cloudflare Pages  Cloudflare Pages

Latest commit: 453bf81
Status: ✅  Deploy successful!
Preview URL: https://ea977517.knurling-defmt-book.pages.dev
Branch Preview URL: https://add-version-info.knurling-defmt-book.pages.dev

View logs

Urhengulas
Urhengulas requested changes Jan 21, 2025
View reviewed changes
book/src/introduction.md
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about making that a separate page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm afraid I don't have the context for this comment. Making what a separate page?

Copy link
Member

Choose a reason for hiding this comment

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

Ah sorry, I meant the components. Adding it as components.md just after the introduction.

book/src/defmt-versions.md
- Supported encodings:
- RZCOBS: noted by presence of the symbol `_defmt_encoding_ = rzcobs`
- RAW: noted by presence of the symbol `_defmt_encoding_ = raw`
- Withdrawal notice: This version will be supported in new releases of the `defmt-decoder` and `defmt-print` crates for at least the next 24 months, on a rolling basis. Notice will be given here when that 24 month period begins.
Copy link
Member

Choose a reason for hiding this comment

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

There are no legal obligations by stating that, are there?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's check on Zulip.

Urhengulas
Urhengulas approved these changes Jan 24, 2025
View reviewed changes
Copy link
Member

@Urhengulas Urhengulas left a comment

Choose a reason for hiding this comment

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

Good for me. I'd put the components in a separate page, but its okay if you don't like that.

@jonathanpallant
Copy link
Contributor Author

Good for me. I'd put the components in a separate page, but its okay if you don't like that.

Let's do that as a follow-up.

@jonathanpallant jonathanpallant added this pull request to the merge queue Jan 27, 2025
Merged via the queue into main with commit dc64101 Jan 27, 2025
24 checks passed
@jonathanpallant jonathanpallant deleted the add-version-info branch January 27, 2025 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Urhengulas Urhengulas Urhengulas approved these changes

Assignees
No one assigned
Labels
skip-changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jonathanpallant @Urhengulas