-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
fix(docs): fix broken links in ./lvgl/README.md #7146
Conversation
Can we fix it with Sphinx redirect so that the old links will work too? |
I'm on it. |
Hi, Gábor! ( @kisvegabor ) I am ready with the links that were in I added just that subset of changes into the And it is making me wonder if I need to make a file-rename map, since my need to remember where things went has come up many times now.... |
Hi, Gábor! ( @kisvegabor ) Because thinking through where documents moved has now come across my plate so many times (including the modifications to Kind regards,
|
Also, now that I have this in list form, in theory, all of the MOVED files could be put into the This seems a bit far, but it is doable, and would not take long. And it would ELIMINATE 404 errors no matter where in the field they were stored. Let me know. Kind regards, P.S. This is what it would look like:
|
Wow, there are a lot links to fix. Can we make use of wildcards? |
I believe I saw some facilities for wildcards. However, given I have the list and a generated test, we don't need wildcards. It would just make it more complicated. You can see it on my demo website. I did a copy/paste of the above into http://crystal-clear-research.com/for_gabor/demo/docs.lvgl.io/master/layouts/flex.html Kind regards, |
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.
Thank you Vic!
I've tested a few links and they worked well! I'll announce the reorganized docs when when it's merged.
Perfect!! |
@kisvegabor P.S. Don't forget PR #7144. Reason: it adds a lot of documentation quality to styles, flex, and grid! They read so much better! |
@kisvegabor P.P.S. Sorry to invalidate your approval above, but I had not yet added in the rest of the redirects -- which WAS already showing and present in the "demo web site". The redirects that were previously present are unchanged, just more was added (what you tested on-line in the links above). |
...fix a few broken links in translated README files. (Full URLs in the README's have to be spelled out because they do not get translated by Sphinx. So :ref: links won't work. Also, 2 paths changed after the translated README's had changed: - modules => main-components - add-lvgl-to-your-project/project =>add-lvgl-to-your-project/connecting_lvgl
517f95b
to
422d950
Compare
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.
Perfect, thank you!
By the way, the new redirects dictionary in Thank you, @FASTSHIFT ! You merged this as I was typing this message! Kind regards, |
Fixes links in ./lvgl/README.md that were broken from PR #7136.
cc: @kisvegabor
Notes
lv_conf_template.h
run lv_conf_internal_gen.py and update Kconfig. n/ascripts/code-format.py
(astyle v3.4.12
needs to installed by runningcd scripts; ./install_astyle.sh
) and follow the Code Conventions. n/a