Skip to content

docs: add developer GitHub Pages site - #8

Merged
sks merged 1 commit into
mainfrom
docs/developer-pages
Nov 13, 2026
Merged

sks merged 1 commit into
mainfrom
docs/developer-pages

Conversation

@sks

@sks sks commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a shareable GitHub Pages developer site for CCE Action, published entirely from docs/.

Developer-facing content

  • Clear value proposition and simple scan quick start.
  • Visual Cloud API evidence example and supported languages/providers.
  • Links to maintained scan, PR-review, access-request, quickstart, and lens-verification examples.
  • Plain-language custom lens explanation with pinning guidance.
  • Privacy defaults, IAM review boundaries, static-analysis limitations, practical requirements, and FAQs.
  • Exact-release versus moving-major-tag guidance.

The site focuses on developer outcomes and setup. It does not document orchestration internals, diagnostic endpoints, agent workflows, or implementation details.

Publishing

  • Adds a standard GitHub Pages workflow deploying the static docs/ directory on relevant main pushes and manual dispatch.
  • Uses plain HTML/CSS with no build toolchain, external assets, or JavaScript.
  • Adds .nojekyll and a short maintainer guide with local preview instructions.
  • Links the repository README to the future site and updates its pinned-release example to v0.3.0.

Validation

  • npx --yes html-validate docs/index.html
  • actionlint .github/workflows/pages.yml
  • git diff --check
  • Local HTTP smoke test for index.html and assets/styles.css
  • Verified all local anchors/resources and all six example links against maintained files.

After merge, the Pages workflow will enable/configure workflow-based Pages and deploy to https://stackgenhq.github.io/cce-action/.

@sks
sks merged commit 1de473b into main Nov 13, 2026
5 checks passed
@sks
sks deleted the docs/developer-pages branch November 13, 2026 20:30
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