docs: publish gpu-capture + cosim-perf-report (were orphaned)#188
Merged
Conversation
`docs/gpu-capture.md` (#174) and `docs/cosim-perf-report.md` (#175) were added as files but never registered in SUMMARY.md, so mdBook never rendered them — `gpu-eda.github.io/Jacquard/gpu-capture.html` 404s. The CHANGELOG references them, so the new version-pinned release-note links (ci/versioned-docs) would point at 404s. Register both pages under the tracing/observability group so they render and the links resolve. Surfaced by the versioned-docs link check; the mdBook doc-link checker missed it because nothing *inside* the book linked to these pages. Co-developed-by: Claude Code v2.1.201 (claude-opus-4-8)
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.
docs/gpu-capture.md(#174) anddocs/cosim-perf-report.md(#175) were added as files but never registered inSUMMARY.md, so mdBook never rendered them —gpu-eda.github.io/Jacquard/gpu-capture.htmlcurrently 404s.The CHANGELOG references both, so the version-pinned release-note links from #187 (
ci/versioned-docs) would point at 404s. This registers both pages (under the tracing/observability group) so they render and the links resolve.Why the doc-link checker missed it: it validates links within the rendered book against
SUMMARY.md; nothing inside the book linked to these pages (they're referenced only from code comments + CHANGELOG), so an orphaned-but-on-disk page slipped through. Verified locally:mdbook buildnow emitscosim-perf-report.html+gpu-capture.html, and neither page has outbound.mdlinks.Should land before cutting the next RC, so its notes'
…/<tag>/gpu-capture.htmllinks work.