docs: fix the strict-mode Pages build - #566
Merged
Merged
Conversation
The v2.8.0 Pages deploy failed with "Aborted with 10 warnings in strict mode": several top-level engineering docs lived in docs/ but were absent from nav, and grouping-engine-scaling-plan.md linked to a results doc that nav never listed either. - Add a "Design Notes" nav section for the three design plans. - List multicast-usage.md under the .mc namespace; it was an orphan too. - Delete aggregation-fast-path-results.md and grouping-engine-scaling-results.md: raw measurement dumps belong with the benchmark harness, not the published site. The two references to them in the scaling plan now point at bench/groupby_shapes/.
singaraiona
force-pushed
the
fix/unpublish-engineering-docs
branch
from
September 17, 2026 21:57
2fe5944 to
17bc874
Compare
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
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.
What & why
The v2.8.0 release job failed at the Pages step with
Aborted with 10 warnings in strict mode!. (The red mkdocs-material "MkDocs 2.0" banner in the same log is a red herring.)Reproduced locally against
origin/dev: all ten warnings are dangling links out ofdocs/grouping-engine-scaling-results.mdintobench/groupby_shapes/results/...andtest/test_agg_contract.c— paths outsidedocs_dir, so mkdocs cannot resolve them. The five top-level engineering docs missing fromnavwere only INFO, not warnings, but they were orphan pages either way.Removed
Raw measurement dumps belong with the benchmark harness, not the published site:
aggregation-fast-path-results.mdgrouping-engine-scaling-results.mdThe two references to the scaling results in
grouping-engine-scaling-plan.mdnow point atbench/groupby_shapes/instead of the deleted page.Published
New "Design Notes" nav section, so the plans are reachable rather than orphaned:
aggregation-fast-path-plan.mdgrouping-engine-scaling-plan.mdmulticast-implementation-plan.mdAlso listed
multicast-usage.mdunder the.mcnamespace — it was an orphan page too.Verification
mkdocs build --strictrun locally with.github/requirements-docs.txt:origin/dev:Aborted with 10 warnings in strict mode!(exit 1)Documentation built in 3.19 seconds(exit 0)Also checked: no remaining references to either removed doc in
docs/ormkdocs.yml, and every top-leveldocs/*.mdis now innavornot_in_nav.Note
pages.ymlonly triggers on pushes tomaster, so PR CI never builds the docs — this class of failure can currently only surface during a release. Worth a separate PR-triggered strict-build job.