Repository navigation
Upgrade to docs-spec-template 5a3a96e (fixes home/index.html 404s) - #170
Merged
Merged
Conversation
Picks up the fixes for the two issues this repo raised yesterday, both merged upstream (template PRs #153 and #154). scripts/build-pages-site.sh now emits home/index.html. The shared UI bundle links to that path from every page -- header logo, breadcrumb and nav root -- and a single-repo build has no `home` component, so every page 404'd on the logo and the breadcrumb. Only the nav link was configurable; the other two hardcode the path, so emitting the file is the only lever a standalone build has. Upstream's version also guards the case where a repo genuinely ships its own `home` component. tests/release-info-test.sh now drives a copy of release-info.sh from a scratch repo with no .docmode, pinning the suite to spec mode wherever it runs. It reports 78 passed, 0 failed here; before this it reported 55/23, failing every phase assertion for correct doc-mode behaviour. MIGRATION.md drops the stale doc-mode instruction to hand-edit version-bot.yml -- upstream already ships that gating, as noted when this repo migrated. .vale.ini ships a real config and is reclassified from template-owned to shared, so UPGRADING.md's copy list no longer includes it. Taken as-is rather than merged with ours. The practical effect is that RedHat and Vale.Spelling are no longer enabled: 197 errors -> 4 across modules/ROOT/pages. Ours also spelled the threshold key `minAlertLevel`, which Vale ignores outright ("W101 'minAlertLevel' isn't a core option"), so the intended alert level was never actually applied. .gitignore picks up /.github/styles/, the Vale package cache that `vale sync` fetches on every run. Those four directories had been sitting untracked in this repo since the Vale setup landed. Verified: 78/78 in doc mode; build-pages-site.sh emits the redirect and a link sweep over the built site reports zero missing targets, down from 16 pages referencing home/index.html; Antora content-source gate clean; PDF and HTML build with the front matter intact. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Bill Traynor <wmat@riscv.org>
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.
Upgrades the tooling baseline from template
main@7456637to @5a3a96e,picking up the fixes for the two issues this repo raised during the migration.
Both are merged upstream and closed as completed.
Follows
UPGRADING.md§2: template-owned files taken wholesale, shared filesmerged by hand.
The regression from #168 is fixed
scripts/build-pages-site.shnow emitshome/index.html(riscv/docs-spec-template#151 → PR #153).
The shared UI bundle links to that path from every page — the header logo,
the "RISC-V Specifications" breadcrumb, and the nav root — and a single-repo
build has no
homecomponent, so all three 404'd. Onlypartials/nav.hbswasconfigurable;
header-content.hbsandbreadcrumbs.hbshardcode the path, soemitting the file was the only available lever. Upstream's version also guards
the case where a repo genuinely ships its own
homecomponent.A link sweep over the built site now reports zero missing targets, down from
16 pages referencing
home/index.html.The test suite passes in doc mode
tests/release-info-test.shdrives a copy ofrelease-info.shfrom a scratchrepo with no
.docmode, pinning the suite to spec mode wherever it runs(riscv/docs-spec-template#152 → PR #154).
The 23 failures were all phase assertions comparing against the empty string that
doc mode is supposed to return — the suite was reporting failures for correct
behaviour.
.vale.ini— taken as-is, and it changes lintingUpstream now ships a real config and reclassifies the file from template-owned to
shared, so
UPGRADING.md's copy list no longer includes it.Taken as-is rather than merged with ours. Two consequences worth reviewing:
RedHat and
Vale.Spellingare no longer enabled. Measured acrossmodules/ROOT/pages/:The difference is
RedHat.PassiveVoice,RedHat.Definitions,RedHat.Spellingand
Vale.Spelling. Upstream excludes the genericValestyle deliberately —spec prose is dense with mnemonics and CSR names its dictionary lacks. Since this
repo is the writing guide rather than a spec, that trade-off is worth a second
look; re-enabling means adding
RedHatback to bothBasedOnStylesandPackages, which upstream owns.Our threshold key was silently dead. Ours read
minAlertLevel; Vale wantsMinAlertLeveland reportsW101 'minAlertLevel' isn't a core option; Vale is ignoring it. The intended alert level was never applied. Upstream's spelling iscorrect.
Housekeeping
MIGRATION.mddrops the stale doc-mode instruction to hand-editversion-bot.yml— upstream already ships that gating, which is what this repofound during the migration.
.gitignorepicks up/.github/styles/, the Vale package cachevale syncfetches on every run. Those four directories had been sitting untracked here
since the Vale setup landed;
git statusis clean now..template-versionrecords the new baseline.Verification
release-info.sh mode→doc;tests/release-info-test.sh→ 78/78build-pages-site.sh→ emits the redirect; link sweep reports 0 missingmake build-container→ PDF and HTML build, front matter intact🤖 Generated with Claude Code