fix(docs): repair root-relative README and tool guide links - #6750
Closed
simpleqt wants to merge 1 commit into
Closed
fix(docs): repair root-relative README and tool guide links#6750simpleqt wants to merge 1 commit into
simpleqt wants to merge 1 commit into
Conversation
- README.md language switcher used href="/README_CN.md" and href="/README.md"; on GitHub absolute paths resolve against the domain, not the repo, so both 404. Drop the leading slash so they resolve to the sibling files in the repository root. - ui/public/tool/*/detail.md referenced screenshots via /admin/tool/img/*.jpg. The images actually live in ui/public/tool/img/ and the /admin/ prefix is host-absolute: it only happens to work in a default MaxKB deployment (ADMIN_PATH=/admin) and breaks on GitHub or any custom ADMIN_PATH. Replace with relative ../img/ paths that point at the real files in the repo.
Contributor
|
The use of absolute paths is for the program to use, and using relative paths will cause the program image to 404 |
Author
|
You're right — thank you for catching it. I misread the root-relative image paths as broken links; they're the runtime URL convention the app resolves, and my relative-path rewrite would 404 the images. The README link change falls under the same misreading (both forms work on GitHub). Closing agrees with me — no part of this should land. Sorry for the noise. |
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
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.
href="/README.md"; on GitHub absolute paths resolve against the
domain, not the repo, so both 404. Drop the leading slash so they
resolve to the sibling files in the repository root.
/admin/tool/img/.jpg. The images actually live in ui/public/tool/img/
and the /admin/ prefix is host-absolute: it only happens to work in a
default MaxKB deployment (ADMIN_PATH=/admin) and breaks on GitHub or
any custom ADMIN_PATH. Replace with relative ../img/ paths that point
at the real files in the repo.