Move static HTML site to docs root so GitHub Pages serves docs/index.html#3
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d7ab86c318
ℹ️ 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".
| { title: "Overview", href: "pages/overview.html" }, | ||
| { title: "Service Definition", href: "pages/service-definition.html" }, | ||
| { title: "Operating Model", href: "pages/operating-model.html" }, |
There was a problem hiding this comment.
Fix nav links for pages served from docs/pages
These hrefs are relative to the current page, so when docs/pages/*.html loads ../assets/app.js, links like pages/overview.html resolve to docs/pages/pages/overview.html and 404; this breaks the nav and search results on every inner page even though docs/index.html still works. Use absolute paths or adjust the base (e.g., prefix ../) for pages loaded from docs/pages/.
Useful? React with 👍 / 👎.
Motivation
index.htmlatdocs/to serve the static site, and the site was previously nested underdocs/site/causing a 404.docs/for cross-linking and maintenance.Description
docs/site/into thedocs/root by placingindex.htmlatdocs/index.html,assets/atdocs/assets/, andpages/atdocs/pages/, and removed thedocs/site/README.mdplaceholder.README.mdandCODEX_INSTRUCTIONS.mdto referencedocs/index.htmland the newdocs/assets/docs/pageslayout.../../with../in page files and updated nav/search asset paths).https://<org>.github.io/cloud-security-service-model/viadocs/index.html.Testing
python - <<'PY' ...) to rewrite README andCODEX_INSTRUCTIONS.mdreferences, which completed successfully.rgsearches fordocs/paths and inspected theCODEX_INSTRUCTIONS.mdexcerpt to ensureindex.htmland asset/page entries point underdocs/.sed -n '1,80p' docs/pages/overview.html) to confirm relative links were corrected..github/workflows/ci.yml.Codex Task