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.

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

Merged
merged 3 commits into from
Feb 13, 2024
Merged

Docs improvement #3515

merged 3 commits into from
Feb 13, 2024

Conversation

obrusvit
Copy link
Contributor

@obrusvit obrusvit commented Feb 5, 2024

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 in docs/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 current main. The script currently lists:

  • core/misc/disc1.md
  • storage/addon-block.md
  • python/show-text.md

@obrusvit obrusvit self-assigned this Feb 5, 2024
docs/core/src/apps.md Outdated Show resolved Hide resolved
Copy link
Contributor

@matejcik matejcik left a 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?

@obrusvit
Copy link
Contributor Author

obrusvit commented Feb 7, 2024

check_docs_summary should be added to one of the prebuild check CI steps. style_check most likely?
Agreed, added it to Makefile: 0b83095

However, I haven't yet linked the 3 missing files, they might be obsolete.

@matejcik
Copy link
Contributor

matejcik commented Feb 7, 2024

Agreed, added it to Makefile: 0b83095

that doesn't help if it does not fail the CI step though. nobody reads the warnings no a green test

@matejcik
Copy link
Contributor

matejcik commented Feb 7, 2024

  • show-text.md should be dropped
  • addon-block.md should be dropped (that's actually a very old design for the translation blob)
  • disc1.md should be linked

@obrusvit
Copy link
Contributor Author

obrusvit commented Feb 7, 2024

Agreed, added it to Makefile: 0b83095

that doesn't help if it does not fail the CI step though. nobody reads the warnings no a green test

Ok. Now it fails loudly
image

And I removed the obsolete docs.

@obrusvit
Copy link
Contributor Author

obrusvit commented Feb 7, 2024

Rebased and added links for TOIF tool as requested AFK.

@obrusvit
Copy link
Contributor Author

obrusvit commented Feb 7, 2024

Rebased on main again.

@obrusvit obrusvit merged commit 1cddc4c into main Feb 13, 2024
60 of 61 checks passed
@obrusvit obrusvit deleted the obrusvit/docs-improvement branch February 13, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants