CDP Index

Where the Documentation Is Hosted

3 min read

Where the Documentation Is Hosted

The public documentation for the CDP Adaptation & Action Explorer is hosted here:

https://cdp-action-explorer.net/docs/

That is the canonical docs URL. Use it in GitHub issues, pull requests, handoff notes, support replies, and public references.

The documentation is no longer published as the production docs site through GitHub Pages. The former GitHub Pages target at https://cdpworldwide.github.io/cdp-adapt-ex/ should not be used as the live documentation URL.

Answer for GitHub Threads

When someone asks in GitHub where the docs are hosted or why the old GitHub Pages URL is not current, point them to this answer:

The CDP Adaptation & Action Explorer docs are hosted directly on the production frontend at https://cdp-action-explorer.net/docs/. The docs source still lives in docs/ in the app repo, but the built VitePress site is now bundled into the frontend artifact and served by the production frontend. GitHub Pages is not the live docs host for this product anymore.

If the question is about whether /docs without the trailing slash is valid, the answer is yes: it redirects to /docs/. The canonical URL to share is still https://cdp-action-explorer.net/docs/.

Current Setup

The documentation source still lives in the app repository under docs/ and is built with VitePress. The VitePress base path is /docs/, so generated asset and page links are rooted under the frontend site’s documentation path.

During frontend builds, the docs are compiled into the frontend artifact:

npm run docs:build:frontend

That command writes the static site to:

frontend/dist/frontend/browser/docs

The frontend container serves those files through frontend/nginx.conf. The /docs/ location uses clean URL fallback rules so pages such as /docs/data resolve to the generated VitePress HTML. The exact /docs path redirects to /docs/ with a relative redirect.

Deployment Path

Documentation changes now ship with the frontend deployment rather than a separate GitHub Pages publication step.

The important promotion path is:

  1. Merge documentation changes into main.
  2. Promote main into production.
  3. Let the production frontend deploy workflow publish the Cloud Run frontend service.
  4. Verify https://cdp-action-explorer.net/docs/ and at least one nested page.

PR CDPworldwide/cdp-adapt-ex#34 made the hosting change and was merged on 2026-07-01. The merge commit was afd796b5136e4f944ad19a6d219517eccbe20038.

The production promotion on 2026-07-02 used commit 91b216ec81f362361b193447bb235c83fa446d73 on production with message Merge main into production. A follow-up hotfix fixed the /docs redirect behavior:

  • 1529fd8a8d8770a035aaa8c05310ede508d084e2 on production: Fix docs redirect in production nginx
  • 765684bdffaa50101871edb2c07353afa8fd46f8 on main: Fix docs redirect in nginx

The production deploy for the redirect hotfix completed successfully in GitHub Actions run 28600762053.

Verification

Use these checks after a docs or frontend production deploy:

curl -I https://cdp-action-explorer.net/docs
curl -I https://cdp-action-explorer.net/docs/
curl -L https://cdp-action-explorer.net/docs/data

Expected results:

  • /docs returns a redirect with location: /docs/.
  • /docs/ returns 200.
  • /docs/data returns 200 and loads the VitePress page for data integration.

Also open the site in a browser and confirm the documentation shell renders, the search/menu controls are present, and no console errors appear on initial load.

Operational Notes

Keep links in GitHub comments, documentation, and support material pointed at /docs/ with the trailing slash. The slashless /docs route is supported, but the canonical URL is https://cdp-action-explorer.net/docs/.

The GitHub Pages workflow remains useful as documentation CI if it validates the VitePress build, but it should not be treated as the public deployment path unless the hosting model changes again.

Graph View

Backlinks