docs: add a placeholder landing page for GitHub Pages - #274
Merged
Conversation
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
|
❌ The last analysis has failed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-pagesbranch contains only.nojekyll, so https://stackguardian.github.io/tirith/ currently returns 404. This would be the first content that URL has served.Serving from the repo tree needs a one-time settings change, since Pages is currently pointed at the empty
gh-pagesbranch: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 onfeat/gate-capable-engine, so if Pages is pointed atmainthe page appears when #272 lands.docs/.nojekyllkeeps Jekyll away from the.mdand.giffiles 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 viaprefers-color-scheme; one column; no images, no fonts, no external requests.Copy
Derived from
README.mdrather 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:
src/referencesopaorrego, so it is absent from the page.counts.approval_requiredexists, butplatform/cli.pyreports it as a warning that explicitly does not block — too weak to sell as a feature.report.pyonly renders findings the platform returns.providers/infracost), masking, the exit-code split and the bundle keeping documents next tocode/are all verified against the source.No testimonials, no logos, no metrics, no signup form.
The
@v2problem, againThe one example on the page uses
@v2, which does not exist — the newest tag on the action isv1.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.