fix(docs): pin the site section title so it renders as nixfiles #97

2026-08-19T18:16:07+01:00

lyrathorpe commented

2026-08-19 18:16:07 +01:00

Follow-up to #96, found while checking the Terraform repo against the nav change.

The problem

lyrathorpe/docs-site#2 removes the hardcoded nav: so awesome-pages can discover the synced trees. That nav also carried the section labels:

nav:
  - Terraform: terraform
  - nixfiles: nixfiles

Without it, MkDocs derives each section name from its directory and title-cases it. terraform still renders as "Terraform", so that section is unaffected — but nixfiles becomes "Nixfiles".

The fix

Set title: nixfiles in docs/.pages. That keeps the label where the section owns it, rather than putting a nav entry back in the site repo.

Validation

Rebuilt the aggregated site locally with both source trees synced exactly as build.yml does (mkdocs 1.6.1, mkdocs-material 9.7.7, awesome-pages 2.10.1): no nav warnings, section renders as nixfiles, page order unchanged. nix flake check passes.

Follow-up to #96, found while checking the Terraform repo against the nav change. ## The problem `lyrathorpe/docs-site#2` removes the hardcoded `nav:` so awesome-pages can discover the synced trees. That nav also carried the section labels: ```yaml nav: - Terraform: terraform - nixfiles: nixfiles ``` Without it, MkDocs derives each section name from its directory and title-cases it. `terraform` still renders as "Terraform", so that section is unaffected — but `nixfiles` becomes **"Nixfiles"**. ## The fix Set `title: nixfiles` in `docs/.pages`. That keeps the label where the section owns it, rather than putting a nav entry back in the site repo. ## Validation Rebuilt the aggregated site locally with both source trees synced exactly as `build.yml` does (mkdocs 1.6.1, mkdocs-material 9.7.7, awesome-pages 2.10.1): no nav warnings, section renders as `nixfiles`, page order unchanged. `nix flake check` passes.

lyrathorpe added 1 commit 2026-08-19 18:16:07 +01:00

fix(docs): pin the site section title so it renders as nixfiles

CI / flake (push) Skipped

CI / flake (pull_request) Successful in 1m10s

Details

9d199bc087

With no entry in the docs-site nav (removed there so awesome-pages can
discover the synced trees), MkDocs derives the section name from the directory
and title-cases it, rendering "Nixfiles". The previous hardcoded nav spelled it
lowercase. Setting title in docs/.pages restores that without reintroducing a
nav entry.

Verified by rebuilding the aggregated site locally with both source trees
synced as the workflow does.

lyrathorpe merged commit 1ff333a896 into main

2026-08-19 18:24:40 +01:00

lyrathorpe deleted branch fix/docs-section-title

2026-08-19 18:24:41 +01:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lyrathorpe/nixfiles#97