doc: small fix of "Getting Started" document structure in section docker #17756
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gschorcht
added
CI: skip compile test
gschorcht
force-pushed
the
doc/fix_getitng_started_docker
branch
from
ee9f494 to
4fc8ba3
Compare
aabadie
reviewed
Mar 6, 2022
doc/doxygen/src/getting-started.md
Outdated
Comment on lines
326
to
327
| Usage | ||
| ------- |
There was a problem hiding this comment.
Suggested change
| Usage | |
| ------- | |
| Usage | |
| ----- |
(You can squash directly)
aabadie
approved these changes
Mar 6, 2022
Fixes two problems: - Section "Usage" which describes the usage of docker is on heading level 1 but has to be on heading level 2 - Section "Setup" has only one subsection. A second subsection was added. Now, the section "Setup" has two subsections, one that describes the installation of docker and one that describes downloading and testing of the RIOT docker build image.
Backticks in headings no longer seem to work in doxygen markdown support.
gschorcht
added
the
CI: ready for build
gschorcht
force-pushed
the
doc/fix_getitng_started_docker
branch
from
4fc8ba3 to
4220f65
Compare
|
Thanks for reviewing and merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This PR fixes the following problems:
Testing procedure
make docshould give the following results fordoc/doxygen/html/getting-started.htmlIssues/PRs references