Skip to content

feat(site): serve a landing page at / and the docs at /docs/ - #14

Open
pimlock wants to merge 6 commits into
mainfrom
feat/landing-page/pimlock
Open

pimlock wants to merge 6 commits into
mainfrom
feat/landing-page/pimlock

Conversation

@pimlock

@pimlock pimlock commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Serve a small landing page at / and move the docs to /docs/ on Netlify, so the site and docs deploy together as one Netlify site.

  • www/ holds the static files served at /, currently the landing page. Its copy is taken from the core README (intro, Quickstart, How It Works, Explore Further) and the repository description; it adds no new claims. The install commands have copy buttons, the Explore Further cards link into the docs, and the CNCF footer matches the docs. It uses theme/tokens.css and the docs' text, card, and code-block styles. The theme toggle shares its setting with the docs.
  • scripts/website.mjs builds build/website from the landing page and the docs build, with the docs under docs/. It fails if the docs were not built with BASE_PATH=/docs/.
  • netlify.toml sets BASE_PATH=/docs/, runs npm run website after the build, and publishes build/website.
  • New mise run website and mise run serve-website tasks. The GitHub Pages workflow is unchanged.

Testing

  • BASE_PATH=/docs/ npm run build && npm run website on main after feat(site): publish the latest release without a version in the URL #15: 350 pages and 232 redirect pages.
  • Served build/website locally: /, /docs/, every docs link on the landing page (real pages, not redirects), and every landing asset return 200. /docs/ serves the latest release home (unversioned URLs from feat(site): publish the latest release without a version in the URL #15). No root-absolute link in the docs build points outside /docs/.
  • Checked the landing page in light, dark, and 390px-wide layouts, and a docs page under /docs/. No horizontal overflow at either width.
  • In headless Chromium, each copy button puts its exact command on the clipboard. The theme toggle carries over to the docs.
  • npm run lint and npm test (28 tests) pass.

Not tested: the Netlify deploy preview itself, and /docs without a trailing slash on Netlify.

@netlify

netlify Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for ai-openshell-docs ready!

Name Link
🔨 Latest commit a503216
🔍 Latest deploy log https://app.netlify.com/projects/ai-openshell-docs/deploys/6b00c873effa36bf5046283e
😎 Deploy Preview https://deploy-preview-14--ai-openshell-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Netlify now builds the docs with BASE_PATH=/docs/ and publishes build/website, which scripts/website.mjs assembles from the static landing page in landing/ and the docs build. The GitHub Pages workflow is unchanged.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
…able

Each install command gets a copy button. The terminal frame, cards, text colors, and code colors now follow the docs theme, and the header gains a GitHub link and a theme toggle shared with the docs. The feature cards link to the matching docs pages.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
"landing" already names topic landing pages in the assembler, and "content" names the generated Astro content. www/ holds the static files served at the site root.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
The footer keeps the CNCF line and logo.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
The hero, Quickstart, How It Works, and Explore Further sections now reuse the ai-openshell/openshell README text and the repository description, instead of new copy.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Since #15 the latest release is served without a version in the URL, and /latest/ only redirects there.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
@pimlock
pimlock force-pushed the feat/landing-page/pimlock branch from 8c851d9 to a503216 Compare November 20, 2026 22:23

This branch has not been deployed

No deployments
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.

1 participant