doc/guides: remove toc from managing a release and fix using timers guide#21773
Conversation
LasseRosenow
requested review from
AnnsAnns,
aabadie and
jia200x
as code owners
crasbe
added
Type: cleanup
| 8. [Resources](#8-resources) | ||
| 9. [Forum Post Templates](#9-forum-post-templates) | ||
|
|
||
| ## 1. Checklist |
There was a problem hiding this comment.
Not sure if it is still necessary to have the "1.", "2." in front of the headline then?
There was a problem hiding this comment.
I mean it looks fine, I actually kind of like that in the sidebar since this guide is meant to be followed in that order and compared to other guides the maintainer will probably hop in/out of the guide multiple times
There was a problem hiding this comment.
I agree with AnnsAnn, I think in this case it is quite useful, we are doing a similar thing with the c tutorials or c basics, where we say "step 1" "step 2" etc.
There was a problem hiding this comment.
|
I noticed that the using timers tutorial has two times step 1 in the headings, so I adjusted it so that it is similar to how the other tutorials are structured |
LasseRosenow
changed the title
crasbe
added
CI: ready for build
AnnsAnns
left a comment
AnnsAnns
left a comment
There was a problem hiding this comment.
Ty for noticing the issue with the timers.md titles 🙇
5 participants
Contribution description
The managing a release guide had its own table of contents even though starlight generates one on the side.
It is the only guide that did this and I think it is not relevant to have it.
I also fixed the heading structure in the using timers tutorial