Skip to content

docs: add a placeholder landing page for GitHub Pages - #274

Merged
refeed merged 1 commit into
feat/gate-capable-enginefrom
docs/landing-page
Aug 13, 2026
Merged

docs: add a placeholder landing page for GitHub Pages#274
refeed merged 1 commit into
feat/gate-capable-enginefrom
docs/landing-page

Conversation

@refeed

@refeed refeed commented Aug 13, 2026

Copy link
Copy Markdown
Member

A placeholder landing page, living in the repo at docs/index.html, as a stopgap until the designer rebuilds it.

Pages is enabled on this repo but has never served anything: the gh-pages branch contains only .nojekyll, so https://stackguardian.github.io/tirith/ currently returns 404. This would be the first content that URL has served.

⚠️ Merging this does not publish it

Serving from the repo tree needs a one-time settings change, since Pages is currently pointed at the empty gh-pages branch:

Settings → Pages → Build and deployment → Source: Deploy from a branch → Branch: main / folder: /docs

I have deliberately not made that change — it is a production setting on a public repo, and flipping it before this merges would achieve nothing anyway. Say the word and I will, or it is two clicks.

Note the sequencing: the branch selected there must be one that contains docs/index.html. Based on feat/gate-capable-engine, so if Pages is pointed at main the page appears when #272 lands.

docs/.nojekyll keeps Jekyll away from the .md and .gif files already in that folder.

What it is

Six sections, in the order a stranger needs them: what it is and how to install it, the problem it solves, the two lines you add, what you get, what it works with, and platform mode last.

Deliberately plain — one hand-written HTML file, no site generator, no build step, no JavaScript, about 200 lines including roughly 50 of CSS. The repo has no site tooling and a placeholder is a poor reason to introduce some. Every prose block sits in its own commented <section>, so the copy can be lifted out without reading the markup. Light and dark via prefers-color-scheme; one column; no images, no fonts, no external requests.

Copy

Derived from README.md rather than newly written, so there is one source of truth to keep correct. A comment at the top of the file says so.

Claims are limited to what I could verify in the code:

  • No OPA. Nothing in src/ references opa or rego, so it is absent from the page.
  • No approvals. counts.approval_required exists, but platform/cli.py reports it as a warning that explicitly does not block — too weak to sell as a feature.
  • Checkov is scoped to platform mode, because Tirith does not run it; report.py only renders findings the platform returns.
  • Cost (providers/infracost), masking, the exit-code split and the bundle keeping documents next to code/ are all verified against the source.

No testimonials, no logos, no metrics, no signup form.

The @v2 problem, again

The one example on the page uses @v2, which does not exist — the newest tag on the action is v1.0.0-beta. This matches both merged READMEs rather than diverging from them, so cutting that one tag makes all three surfaces correct at once. It is worth doing before this page is publicly linked, since a landing page is the first thing a stranger copy-pastes.

Pages is enabled on this repo but has never served anything -- the gh-pages
branch contains only .nojekyll, so https://stackguardian.github.io/tirith/
returns 404. This is a stopgap until the designer rebuilds it next week.

Deliberately plain: one hand-written HTML file, no generator, no build step and
no JavaScript, because the repo has no site tooling and a placeholder is a bad
reason to introduce some. Every prose block sits in its own commented <section>
so the copy can be lifted out without reading the markup.

All copy is derived from README.md rather than newly written, so there is one
source of truth to keep correct. Claims are limited to what the code actually
does: no OPA (nothing in src/ references it), and no approvals, since a policy
asking for approval warns rather than gates.

Serving this needs a one-time Pages settings change -- source from a branch,
folder /docs, replacing the empty gh-pages branch. docs/.nojekyll keeps Jekyll
off the existing .md and .gif files in that folder.
@refeed
refeed requested a review from Akshat0694 as a code owner August 13, 2026 10:32
Copilot AI lite review requested due to automatic review settings August 13, 2026 10:32
@refeed
refeed requested a review from arunim2405 as a code owner August 13, 2026 10:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sonarqubecloud

Copy link
Copy Markdown

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

@refeed
refeed merged commit b5a7a5f into feat/gate-capable-engine Aug 13, 2026
17 of 18 checks passed
@refeed
refeed deleted the docs/landing-page branch August 13, 2026 12:29
refeed added a commit that referenced this pull request Aug 13, 2026
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.

2 participants