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

feat(docs): batch 1 of proofread/edited docs #7144

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

vwheeler63
Copy link
Contributor

@vwheeler63 vwheeler63 commented Oct 23, 2024

Major docs task #2 is a thorough proofreading/editing of the docs. The intro docs that were majorly re-written have already been done, but the remainder have not. This is the first of several docs submitted after having been proofread and edited for grammar and clarity to maximize the speed with which new LVGL users can get up to speed and winning with LVGL.

@kisvegabor , here is batch 1 of the proofread docs. This batch is small and should be easy to validate by viewing DIFFs, though I have also placed the updated docs here so it is easy to see "how they read": http://crystal-clear-research.com/for_gabor/demo/docs.lvgl.io/master/ . They are:

  • ./docs/CHANGELOG.rst [link]
    • (Only change was to preserve a link whose ID had changed: search for "Mouse hover handling".)
  • ./docs/details/base-widget/coord.rst [link]
    • ("anchor point" renamed => "anchor" -- reads better)
  • ./docs/details/base-widget/layouts/flex.rst [link]
    • Quite a lot edited with many helpful hyperlinks added to CSS references.
  • ./docs/details/base-widget/layouts/grid.rst [link]
    • Quite a lot edited with many helpful hyperlinks added to CSS references.
  • ./docs/details/widgets/image.rst [link]
    • (Only change was to preserve a link whose ID had changed: search for "properties coming from styles".)

Notes

  • Update the Documentation if needed. n/a
  • Add Examples if relevant. n/a
  • Add Tests if applicable. n/a
  • If you added new options to lv_conf_template.h run lv_conf_internal_gen.py and update Kconfig. n/a
  • Run scripts/code-format.py (astyle v3.4.12 needs to installed by running cd scripts; ./install_astyle.sh) and follow the Code Conventions. n/a
  • Mark the Pull request as Draft while you are working on the first version, and mark is as Ready when it's ready for review. Done.
  • When changes were requested, re-request review to notify the maintainers. Done.
  • Help us to review this Pull Request! Anyone can approve or request changes.

Copy link
Member

@kisvegabor kisvegabor left a comment

Choose a reason for hiding this comment

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

Thank you Vic!

I'd be happy announce that we have a new reorganized docs. However to do so, it'd be great to fix the broken links. I founded that all the links in the README are broken now. 🙁

Could you take look at this issue?

@vwheeler63
Copy link
Contributor Author

Thank you Vic!

I'd be happy announce that we have a new reorganized docs. However to do so, it'd be great to fix the broken links. I founded that all the links in the README are broken now. 🙁

Could you take look at this issue?

Done and submitted in PR #7146.

@kisvegabor kisvegabor merged commit 64a2f3a into lvgl:master Oct 27, 2024
21 checks passed
@vwheeler63 vwheeler63 deleted the feat/docs_proofread_batch1 branch October 27, 2024 14:08
@vwheeler63
Copy link
Contributor Author

@kisvegabor Thank you!

rodb70 pushed a commit to rodb70/lvgl that referenced this pull request Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👀 Review needed Anyone can review a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants