docs: fix stale references and broken links - #11112
Open
vvbandeira wants to merge 1 commit into
Open
Conversation
vvbandeira
requested review from
LucasYuki,
jfgava,
maliberty and
osamahammad21
August 10, 2026 12:10
Remove NewToolDocExample.md: it contradicted ReadmeFormat.md and produced READMEs the man page parser rejects. Its only reference was the conf.py entry excluding it from the build. Fix 14 broken relative links. est pointed at rsz sources, ifp at a misspelled InitFloorPlan.i, grt at a URL with no scheme. The empty [source file]() targets in ReadmeFormat.md propagated into every tool README that copied the template. Keep the main/docs exclude in conf.py: docs/main symlinks to the repo root, so dropping it makes Sphinx discover every page twice. Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
vvbandeira
force-pushed
the
docs-fix-stale-refs
branch
from
August 10, 2026 12:12
9946bc7 to
d2c5a12
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request cleans up and updates various documentation files across the repository. It corrects several broken relative links, updates developer guides and README templates with clearer instructions, reorganizes the manpages test framework documentation, and removes redundant or outdated documentation files. The review feedback points out an incorrect relative link to doc_check_tests.md in docs/src/test/README.md which should go up two levels instead of one.
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.
Summary
Remove NewToolDocExample.md: it contradicted ReadmeFormat.md and produced READMEs the man page parser rejects. Its only reference was the conf.py entry excluding it from the build.
Fix 14 broken relative links. est pointed at rsz sources, ifp at a misspelled InitFloorPlan.i, grt at a URL with no scheme. The empty source file targets in ReadmeFormat.md propagated into every tool README that copied the template.
Keep the main/docs exclude in conf.py: docs/main symlinks to the repo root, so dropping it makes Sphinx discover every page twice.
Type of Change
Impact
Improve docs