fix(doc): remove dead GitHub Pages links and stale jazzy references - #422
Merged
Conversation
GitHub Pages for this repo has been taken down (gh-pages branch deleted, per doc.yaml), so every absolute minipada.github.io link in introduction.md (= README.md via symlink) 404s, including the whole "For detailed instructions" list. Replace it with a pointer to the book's own sidebar and a GitHub repo-browse link, since no relative link syntax can satisfy both the site's root index.html (a raw copy of this chapter's rendered HTML, made by mdbook, that does not rewrite relative links for its new location) and the chapter's real nested path at the same time. Also: - Point the codecov badge at the jazzy branch instead of humble, since CI now uploads coverage there under the cpp-jazzy flag. - Drop the future_work.md roadmap item for container-image build automation on PRs/commits: ci.yaml already does this with Podman. Signed-off-by: David Bensoussan <d.bensoussan@proton.me>
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
doc.yaml), so every absoluteminipada.github.iolink inintroduction.md(=README.mdvia symlink) 404s — including the whole "For detailed instructions" list. Replaced it with a pointer to the book's sidebar and a GitHub repo-browse link. No relative link syntax fixes this instead: mdbook copies the first chapter's rendered HTML to the site's rootindex.htmlwithout rewriting its relative links, so no single relative path resolves correctly at both that root copy and the chapter's real nested path.jazzyinstead ofhumble— CI already uploads coverage there under thecpp-jazzyflag.future_work.mdroadmap item for container-image build automation on PRs/commits:ci.yamlalready does this with Podman.Test plan
tools/ci/pre-commit/build_doc.sh, Podman + pinned mdbook/strictdoc) — clean build, only the 3 pre-existing harmless linkcheck warnings (unrelated[str]/[int]table cells).index.htmlcopy points at a path that 404s.https://claude.ai/code/session_01QFLuMgHLraGekrUyP9gbZL