Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

doc: improve flashing documentation #18577

Merged
merged 1 commit into from
Sep 12, 2022
Merged

doc: improve flashing documentation #18577

merged 1 commit into from
Sep 12, 2022

Conversation

maribu
Copy link
Member

@maribu maribu commented Sep 12, 2022

Contribution description

  • The tool compatibility matrix got super large - split out all "single-purpose" tools and list them per platform
  • Highlighting code via backticks in titles doesn't render well with Doxygen

Testing procedure

Check the generated documentation

Issues/PRs references

#18562 (comment)

@maribu
doc: improve flashing documentation
0c58b6b 
- The tool compatibility matrix got super large
    - split out all "single-purpose" tools and list them per platform
- Highlighting code via backticks in titles doesn't render well with
  Doxygen
@maribu maribu added Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Sep 12, 2022
@maribu maribu requested a review from MrKevinWeiss September 12, 2022 07:21
@maribu maribu mentioned this pull request Sep 12, 2022
Merged
MrKevinWeiss
MrKevinWeiss approved these changes Sep 12, 2022
View reviewed changes
Copy link
Contributor

@MrKevinWeiss MrKevinWeiss left a comment

Choose a reason for hiding this comment

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

Much cleaner, thanks. ACK.

@maribu maribu enabled auto-merge September 12, 2022 08:43
@maribu maribu merged commit aa940a4 into RIOT-OS:master Sep 12, 2022
@maribu
Copy link
Member Author

maribu commented Sep 12, 2022

Thx :)

@maribu maribu deleted the doc/doxygen/src/flashing.md branch September 12, 2022 09:56
@maribu maribu added this to the Release 2022.10 milestone Oct 14, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@MrKevinWeiss MrKevinWeiss MrKevinWeiss approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees
No one assigned
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Milestone
Release 2022.10
Development

Successfully merging this pull request may close these issues.
2 participants
@maribu @MrKevinWeiss