Fix smdcoe nav - #4
Merged
Merged
Conversation
The nav listed the Army SMDCoE story as plays/army-smdcoe-play.md, but the
file is docs/stories/army-smdcoe.md. MkDocs cannot resolve a nav target that
does not exist, so it emitted the raw path as the link href and the navbar
sent readers to /AI4SDLC/plays/army-smdcoe-play.md, which 404s -- both because
no such page exists and because this site uses directory URLs, so no .md URL
ever resolves.
The story itself built and deployed correctly the whole time; only the way in
was broken.
MkDocs did warn about this ("A reference to 'plays/army-smdcoe-play.md' is
included in the 'nav' configuration, which is not found in the documentation
files"), but nothing surfaced it: code.mil's scripts/test runs mkdocs with
--quiet, and its htmlproofer sweep excludes /AI4SDLC/ entirely.
MkDocs was emitting nine link warnings. None failed the build, because code.mil runs the mkdocs build with --quiet and excludes /AI4SDLC/ from its htmlproofer sweep, so nothing surfaced them. Four links pointed at 'ai_sdlc_workflows_play.md'. The file is 'ai_sdlc_workflows-play.md' -- a hyphen, not an underscore, before "play". Four more in aiswec_play-outline.md were still written for the path the file had before it moved into docs/plays/, and carried a '../../docs/' prefix that resolves nowhere from its current location. The authoring notes in that file recorded the move as pending and prescribed exactly this fix, so this applies it and updates the note to describe where the file now lives. One pointed at 'resources/risk-reference.md', which does not exist anywhere in the repository. The surrounding sentence describes the Risk Reference Companion as upcoming, so the reference stays and only the dead link is removed; it can be linked once the document lands. Also repairs a tenth link that MkDocs does not check, because it validates Markdown targets and this one is a directory: documentation-play.md pointed at '../resources/', which has no index page and returns 404 on the live site today. It now links the two resources that exist. Verified by crawling the built site: 1631 internal links, none broken.
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.
No description provided.