Skip to content

Move static HTML site to docs root so GitHub Pages serves docs/index.html#3

Merged
OgeonX-Ai merged 2 commits into
mainfrom
codex/implement-features-as-per-codex-instructions-yoaa8z
Jan 3, 2026
Merged

Move static HTML site to docs root so GitHub Pages serves docs/index.html#3
OgeonX-Ai merged 2 commits into
mainfrom
codex/implement-features-as-per-codex-instructions-yoaa8z

Conversation

@OgeonX-Ai
Copy link
Copy Markdown
Contributor

Motivation

  • GitHub Pages requires an index.html at docs/ to serve the static site, and the site was previously nested under docs/site/ causing a 404.
  • Make the lightweight HTML site directly accessible while keeping the canonical Markdown docs in docs/ for cross-linking and maintenance.
  • Ensure README and the repository instructions reference the new site location.
  • Fix HTML page link paths so in-site navigation and links to Markdown docs work from the new location.

Description

  • Moved the static site artifacts out of docs/site/ into the docs/ root by placing index.html at docs/index.html, assets/ at docs/assets/, and pages/ at docs/pages/, and removed the docs/site/README.md placeholder.
  • Updated README.md and CODEX_INSTRUCTIONS.md to reference docs/index.html and the new docs/assets/docs/pages layout.
  • Adjusted HTML pages to correct relative paths and links to the canonical Markdown docs (replaced ../../ with ../ in page files and updated nav/search asset paths).
  • Applied the file moves and updates in the repository so the static site is reachable at https://<org>.github.io/cloud-security-service-model/ via docs/index.html.

Testing

  • Ran the update script (python - <<'PY' ...) to rewrite README and CODEX_INSTRUCTIONS.md references, which completed successfully.
  • Verified references were updated using rg searches for docs/ paths and inspected the CODEX_INSTRUCTIONS.md excerpt to ensure index.html and asset/page entries point under docs/.
  • Inspected a sample HTML page (sed -n '1,80p' docs/pages/overview.html) to confirm relative links were corrected.
  • Repository CI was not executed as part of this change; CI will run on push/PR according to .github/workflows/ci.yml.

Codex Task

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

Comment thread docs/assets/app.js
Comment on lines +2 to +4
{ title: "Overview", href: "pages/overview.html" },
{ title: "Service Definition", href: "pages/service-definition.html" },
{ title: "Operating Model", href: "pages/operating-model.html" },
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

@OgeonX-Ai OgeonX-Ai merged commit 1115f29 into main Jan 3, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant