-
-
Notifications
You must be signed in to change notification settings - Fork 655
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.
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
Docs improvement #3515
Docs improvement #3515
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
check_docs_summary
should be added to one of the prebuild check CI steps. style_check
most likely?
However, I haven't yet linked the 3 missing files, they might be obsolete. |
that doesn't help if it does not fail the CI step though. nobody reads the warnings no a green test |
|
And I removed the obsolete docs. |
79410d0
to
d6fea1f
Compare
Rebased and added links for TOIF tool as requested AFK. |
[no changelog]
[no changelog]
[no changelog]
760be46
to
6cb07ce
Compare
Rebased on main again. |
This PR fixes some minor issues and obsolete information in firmware documentation which I stumbled upon during my onboarding.
In addition, this PR adds a small script which lists markdown files present in
docs/
which are not referenced indocs/SUMMARY.md
- this is an effort to prevent a situation we had where I didn't know about "Hello World" tutorial because I didn't see it in the web version of the documentation. I referenced the "Hello World" tutorial now so I also rebased it on top of currentmain
. The script currently lists:core/misc/disc1.md
storage/addon-block.md
python/show-text.md