Skip to content

Add mixed-case DocC entrypoint redirect#477

Merged
SoundBlaster merged 3 commits into
mainfrom
codex/docc-mixed-case-redirect
May 29, 2026
Merged

Add mixed-case DocC entrypoint redirect#477
SoundBlaster merged 3 commits into
mainfrom
codex/docc-mixed-case-redirect

Conversation

@SoundBlaster
Copy link
Copy Markdown
Member

@SoundBlaster SoundBlaster commented May 29, 2026

Summary

  • What changed?
    • Moved mixed-case DocC compatibility redirect creation into a Linux artifact preparation job so documentation/SpecGraph/index.html is written on a case-sensitive filesystem.
    • Preserved the generated lowercase DocC entrypoint before adding the mixed-case redirect.
    • Reduced excessive mobile hero spacing on the landing page.
  • Link related issue/task (if any):

Motivation

  • Why is this change needed?
    • The original redirect step ran on macos-14, where the default workspace filesystem is case-insensitive and could overwrite documentation/specgraph/index.html when creating documentation/SpecGraph/index.html.
    • The mobile landing hero had too much vertical whitespace around the platform/status line.
  • What problem, gap, or user need does it address?
    • Keeps the generated DocC documentation entrypoint intact while still publishing the mixed-case compatibility redirect.
    • Improves mobile landing page density and visual balance.

Goals

  • What should this PR achieve?
    • Publish the technical root, lowercase DocC documentation, and mixed-case compatibility redirect without case-collision artifact corruption.
    • Keep the landing page hero compact on mobile.
  • What is intentionally out of scope?
    • Full visual redesign of the landing page.
    • Changes to DocC content generation itself.

Changes

    • Added a prepare-pages-artifact Ubuntu job that downloads the archived DocC output, writes the mixed-case redirect, verifies both lowercase and mixed-case paths, and uploads the Pages artifact.
    • Changed deployment to depend on prepare-pages-artifact.
    • Kept the macOS build job responsible for Swift DocC generation and technical root insertion.
    • Updated landing/index.html mobile hero spacing and removed the hero eyebrow inline margin.

Validation

  • Tests added/updated for changed behavior
  • Local checks passed

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 -sb

Results:

  • Review thread PRRT_kwDORZze8s6Flzzn is resolved via GraphQL.
  • Branch is pushed and working tree is clean.
  • No full workflow run was executed locally.

Risks / Notes

  • Backward compatibility impact:
    • GitHub Pages artifact structure is intended to remain compatible while avoiding macOS case-collision behavior.
  • Migration/config changes required:
    • None.
  • Known limitations:
    • Workflow behavior was not exercised end-to-end locally; relies on GitHub Actions artifact upload/download semantics.

Checklist

  • PR title clearly describes the change
  • Scope is focused and minimal
  • Documentation updated (or N/A)
  • No secrets or sensitive data added

Copilot AI review requested due to automatic review settings May 29, 2026 05:20
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread .github/workflows/pages-technical-root.yml
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.html pointing 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.

@SoundBlaster SoundBlaster merged commit e9904a2 into main May 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants