Add mixed-case DocC entrypoint redirect#477
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3737cd03cf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
This PR aligns the GitHub Pages DocC publishing contract with expected operator-facing URLs by adding a mixed-case compatibility entrypoint (documentation/SpecGraph/) that redirects to DocC’s generated lowercase module path (documentation/specgraph/), and updating references/docs accordingly.
Changes:
- Added a Pages workflow step that writes a static redirect page at
.docc-build/documentation/SpecGraph/index.htmlpointing to../specgraph/. - Updated the GitHub Pages root “Docs” card to link to the mixed-case entrypoint.
- Updated publishing documentation and workflow tests to validate both the generated lowercase DocC output and the mixed-case redirect artifact.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/pages-technical-root.yml |
Adds a build step to create a mixed-case DocC redirect and verifies both DocC paths in the artifact. |
docs/github-pages-root/index.html |
Updates the Docs card URL to the mixed-case DocC entrypoint. |
docs/static_artifact_publish.md |
Documents the mixed-case operator-facing DocC entrypoint and the lowercase generated module path. |
Sources/SpecGraph/Documentation.docc/ArtifactPublishing.md |
Documents GitHub Pages ownership and the redirect boundary for DocC paths. |
tests/test_publish_static_artifacts_workflow.py |
Extends workflow assertions to cover the new redirect step and artifact path. |
Comments suppressed due to low confidence (1)
docs/github-pages-root/index.html:162
- The Docs card now links to the mixed-case compatibility entrypoint (
documentation/SpecGraph/), but the description still calls it the canonical generated entrypoint. Since this URL is a redirect to the generated lowercase DocC output, the wording should be updated to avoid implying this path is the generated/canonical one.
<span class="desc">
Canonical generated technical documentation entrypoint.
</span>
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
documentation/SpecGraph/index.htmlis written on a case-sensitive filesystem.Motivation
macos-14, where the default workspace filesystem is case-insensitive and could overwritedocumentation/specgraph/index.htmlwhen creatingdocumentation/SpecGraph/index.html.Goals
Changes
prepare-pages-artifactUbuntu job that downloads the archived DocC output, writes the mixed-case redirect, verifies both lowercase and mixed-case paths, and uploads the Pages artifact.prepare-pages-artifact.landing/index.htmlmobile hero spacing and removed the hero eyebrow inline margin.Validation
Commands run:
# Pre-commit hooks ran via commits: python-quality (no files to check) spec-yaml-format (no files to check) spec-yaml-lint (no files to check) ruff (legacy alias) (no files to check) ruff format (no files to check) gh api graphql ... reviewThreads gh api graphql ... resolveReviewThread git status -sbResults:
PRRT_kwDORZze8s6Flzznis resolved via GraphQL.Risks / Notes
Checklist