Depends on #9 and on #16.
The README describes the gap this repository was made to fill, which was the
right thing to write on a tree with nothing in it. It says nothing about how to
produce the site, because there was nothing to produce:
gh api repos/Flowfin/site/contents/README.md --jq '.content' | base64 -d | grep -c 'go run'
0
Run 2026-08-08. Once #9 lands the two verbs, somebody arriving here has to read
the source or the workflow files to find out how to build the thing this
repository exists to build, and the first page they landed on told them the
history instead.
What it says. What the repository produces, the one command that produces it,
the one command that checks it, where the output goes, and where the contributor
guide, the security policy, the code of conduct and the licence are. It carries
the pointers and not the contents, because a second copy of an instruction is
the copy that goes stale, and the guide in #16 is the place that goes into
detail.
What it does not do. It does not list the checks. #16 makes that rule for the
contributor guide and it holds here for the same reason: a list in a document
drifts against the workflows that decide it, and the verb prints what it ran.
The paragraph about why this repository exists stays. It is the one thing a
reader cannot derive from the tree, and it is short.
The licence line is the part that cannot be finished yet. #18 needs the SPDX
identifier to appear in the README and entry 1 of #7 is what supplies it, so
until that comes back the README says the licence is not chosen rather than
leaving a reader to conclude anything from an absence. That sentence is what
#18 replaces.
The link to the intended-use notice this repository already carries stays as a
link, and the notice is not restated.
Done when
The README names the build verb and the gate verb, says where the built output
goes, links the contributor guide, the security policy, the code of conduct and
the licence file rather than restating any of them, keeps the link to the
intended-use notice, contains no list of check names, and states either the SPDX
identifier or that the licence is not yet chosen.
Depends on #9 and on #16.
The README describes the gap this repository was made to fill, which was the
right thing to write on a tree with nothing in it. It says nothing about how to
produce the site, because there was nothing to produce:
Run 2026-08-08. Once #9 lands the two verbs, somebody arriving here has to read
the source or the workflow files to find out how to build the thing this
repository exists to build, and the first page they landed on told them the
history instead.
What it says. What the repository produces, the one command that produces it,
the one command that checks it, where the output goes, and where the contributor
guide, the security policy, the code of conduct and the licence are. It carries
the pointers and not the contents, because a second copy of an instruction is
the copy that goes stale, and the guide in #16 is the place that goes into
detail.
What it does not do. It does not list the checks. #16 makes that rule for the
contributor guide and it holds here for the same reason: a list in a document
drifts against the workflows that decide it, and the verb prints what it ran.
The paragraph about why this repository exists stays. It is the one thing a
reader cannot derive from the tree, and it is short.
The licence line is the part that cannot be finished yet. #18 needs the SPDX
identifier to appear in the README and entry 1 of #7 is what supplies it, so
until that comes back the README says the licence is not chosen rather than
leaving a reader to conclude anything from an absence. That sentence is what
#18 replaces.
The link to the intended-use notice this repository already carries stays as a
link, and the notice is not restated.
Done when
The README names the build verb and the gate verb, says where the built output
goes, links the contributor guide, the security policy, the code of conduct and
the licence file rather than restating any of them, keeps the link to the
intended-use notice, contains no list of check names, and states either the SPDX
identifier or that the licence is not yet chosen.