doc: Documentation issue in 'guides/kconfig/tips' - broken hyperlink from kconfiglib to zephyrproject #66701
Assignees
Comments
|
Hi @ngenetzky-appareo! We appreciate you submitting your first issue for our open-source project. 🌟 Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙 |
|
Hi @ngenetzky-appareo -- thanks for the report! It's not clear to me if there is anything to track on the Zephyr side of things? The "Kconfig - Tips and Best Practices" page doesn't have any broken links, correct? It looks as it's rather some broken links in the upstream Kconfiglib docs and published pypi package? |
|
If this information has been moved and you know where that would be helpful
to add here or in the linked ticket.
I am not very familiar with the documentation generator you use, but it's
possibly that an "alias" or "redirect" could be added to fix the issue.
Zephyr has a much larger contributor base and higher quality documentation
than the other project. It is also possible that other projects have also
linked to zephyr's great documentation.
…On Wed, Dec 20, 2023, 12:22 Benjamin Cabé ***@***.***> wrote:
Hi @ngenetzky-appareo <https://github.com/ngenetzky-appareo> -- thanks
for the report! It's not clear to me if there is anything to track on the
Zephyr side of things? The "Kconfig - Tips and Best Practices" page doesn't
have any broken links, correct? It looks as it's rather some broken links
in the upstream Kconfiglib docs and published pypi package?
—
Reply to this email directly, view it on GitHub
<#66701 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AW2VIONN6YBSPEXEBD4DAQLYKMNDVAVCNFSM6AAAAABA42SLFCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRUHA2TMNZVGA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Oh, I see! It used to be at a different URL, gotcha. Yes, we have a way to have redirects. Will make a PR :) |
kartben
added a commit
to kartben/zephyr
that referenced
this issue
Dec 20, 2023
Documentation pages around Kconfig have moved around on a couple of occasions in the past [1] [2] and current redirects were dysfonctional (leading /) and incomplete, while an entire set of redirects was also missing. This notably fixes the "browse latest development version of this page" link on https://docs.zephyrproject.org/2.7.5/guides/build/kconfig/tips.html or a link to the "Kconfig tips" page as found in Kconfiglib's current README (https://pypi.org/project/kconfiglib/) [1] commit 5342bc6 [2] commit 5c88418 Fixes zephyrproject-rtos#66701 Signed-off-by: Benjamin Cabé <[email protected]>
fabiobaltieri
pushed a commit
that referenced
this issue
Dec 21, 2023
Documentation pages around Kconfig have moved around on a couple of occasions in the past [1] [2] and current redirects were dysfonctional (leading /) and incomplete, while an entire set of redirects was also missing. This notably fixes the "browse latest development version of this page" link on https://docs.zephyrproject.org/2.7.5/guides/build/kconfig/tips.html or a link to the "Kconfig tips" page as found in Kconfiglib's current README (https://pypi.org/project/kconfiglib/) [1] commit 5342bc6 [2] commit 5c88418 Fixes #66701 Signed-off-by: Benjamin Cabé <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
Broke hyperlink from https://pypi.org/project/kconfiglib/ to zephyrproject.
Here is the text with the hyperlink:
Environment
CC: @ulfalizer
Cross-Posted:
The text was updated successfully, but these errors were encountered: