Update faq.md to use MD rather than raw HTML - #746
Open
DespicableGoose wants to merge 2 commits into
Open
Conversation
Currently, visiting the generated page (https://mavlink.io/en/about/faq.html) has broken links. This is because the document is explicitly written in raw html, so VitePress does no meaningful transformation from md to generated HTML pages. Since the literal links to other documentation pages are explicitly encoded in the HTML and they link to .md files, these links break upon actual page deployment/generation, since the md files get translated to HTML, and thus the .md files cannot be found, leading to 404 errors. This commit/PR should fix this issue. Sorry for the verbosity of my explanation...
Contributor
Author
|
This is the only page I could find in the documentation with this issue when investigating. I initially noticed the issue naturally, when browsing documentation for other purposes and finding that the links on the FAQ page were invalid. However, when trying to find more issues of this nature specifically, not just broken links in general, I couldn't find any. I wasn't particularly thorough when searching though, I will admit. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, visiting the generated page (https://mavlink.io/en/about/faq.html) has broken links.
This is because the document is explicitly written in raw html, so VitePress does no meaningful transformation from md to generated HTML pages.
Since the literal links to other documentation pages are explicitly encoded in the HTML and they link to .md files, these links break upon actual page deployment/generation, since the md files get translated to HTML, and thus the .md files cannot be found, leading to 404 errors.
This PR should fix this issue. Sorry for the verbosity of my explanation...