Add SpecGraph DocC technical surface#476
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s GitHub Pages technical root documentation/navigation so the “Docs” entry consistently points to the canonical generated DocC documentation entrypoint (rather than docs/ source files in the repo), aligning Pages-root navigation with the intended “Docs = DocC” contract.
Changes:
- Updated the GitHub Pages root “Docs” card link/title/description to the DocC entrypoint URL.
- Updated publishing notes to refer to the canonical DocC URL instead of repository
docs/.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/github-pages-root/index.html | Repoints the “Docs” card on the Pages technical root to the DocC entrypoint and updates the card copy accordingly. |
| docs/static_artifact_publish.md | Updates publishing notes to name the canonical DocC entrypoint as part of the Pages technical entrypoint contract. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e9c941e891
ℹ️ 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".
Summary
documentation/specgraph/.https://0al-spec.github.io/SpecGraph/documentation/SpecGraph/works as the operator-facing docs URL.Motivation
/documentation/...produced 404s.https://0al-spec.github.io/SpecGraph/documentation/SpecGraph/, while DocC emits the generated module path as lowercasedocumentation/specgraph/.Goals
https://0al-spec.github.io/SpecGraph/documentation/specgraph/after merge/deploy.https://0al-spec.github.io/SpecGraph/documentation/SpecGraph/a working compatibility entrypoint.https://0al-spec.github.io/SpecGraph/as the technical root, not the product landing page.workflow_dispatchdeployment behavior for the Pages workflow.Changes
Package.swift,Package.resolved, andSources/SpecGraph/Documentation.docc/*..github/workflows/pages-technical-root.ymlinto a DocC build + Pages deploy workflow.docs/github-pages-root/index.htmlinto.docc-build/index.htmlso the root technical entrypoint remains available.documentation/SpecGraph/redirect to the generated lowercase DocC module path.Validation
Commands run:
git diff --check python -m ruff format tests/test_publish_static_artifacts_workflow.py python -m pytest tests/test_publish_static_artifacts_workflow.py -q python tools/python_quality.py make proposal-tracking-gate swift package --allow-writing-to-directory ./.docc-build generate-documentation --target SpecGraph --output-path ./.docc-build --transform-for-static-hosting --hosting-base-path SpecGraph make PYTHON=python testResults:
documentation/specgraph/index.html.Risks / Notes
make testwithoutPYTHON=pythonuses macOS/usr/bin/python33.9 on this machine and fails on existing Python 3.10 syntax (zip(..., strict=True),str | inttype unions). CI uses Python 3.10.Checklist