Skip to content
This repository was archived by the owner on Oct 15, 2026. It is now read-only.

docs: rewrite the tlnet docs in ASD-STE100 - #19

Merged
jshvn merged 8 commits into
mainfrom
josh/docs-ste
Oct 9, 2026
Merged

jshvn merged 8 commits into
mainfrom
josh/docs-ste

Conversation

@jshvn

@jshvn jshvn commented Oct 9, 2026

Copy link
Copy Markdown
Member

Consistency review, phase 5, for tlnet: C21, C23, C33, C37, C38, C41, C42, C43, C47, C48, C53, C54, C58, C63, C64, C67, C69 and C77 (all Markdown and the landing page in ASD-STE100).

  • SECURITY.md and CONTRIBUTING.md are deleted. The org files cover tlnet (C37, C38).
  • CLAUDE.md has the six-mirror shape (C33). The engine mechanics and the failure runbook move to lib (C64, C67).
  • README.md: LIST_FLOOR (C21), freshness against the clock of CTAN (C23), the pipeline diagram (C41), step 5 and task plan (C42, C43), operation (C47), the zone step (C48), gross cost (C53), signed installers (C54), no private repo names (C63), the two terms (C69).
  • site/index.html: the landing page items (C58).

Merge after the lib docs PR: links here go to sections that it adds.

Test plan

  • Fact check (spec §4) by a second agent; each fix round re-checked
  • Items and STE review; ste-lint on the branch diff
  • task check: render matches render.txt
  • Landing page: tags balance, <!--UPDATED--> once

jshvn added 8 commits October 8, 2026 17:21
C37: the org SECURITY.md holds the guarantees and the report route. This copy linked to a disabled form, and only CLAUDE.md linked to it.
C38: it repeated CLAUDE.md and the org CONTRIBUTING, and the copies drifted. The free-tier rule goes with C53.
C33 shape: 05:42 UTC intro, constraints, must knows, verifying a change. Deletes the list-diff and decision-batch hazards, Verification and security, and Repository guardrails (lib holds the engine facts). C21 floor at about 90%, C23 freshness against CTAN's timestamp, C53 no free-tier claim, C69 the scheduler, C75 writing line. Written for the state after the phase 3 refactor PR.
C23 timestamp freshness, C41 diagram with due, C42 no task plan for a fork, C43 pause the healthcheck, C47 re-dispatch commands, C48 zone intro and rows, C53 gross cost, C54 signed files, C63 no private repo, C64 runbook link to lib, C67 mechanics link to lib, C69 terms.
C58: tlnet's own healthcheck badge, valid strong markup, one link to the README's Want your own?, the landing page as the only own step. C23: Is it fresh? reads CTAN's timestamp.
Review Important 1-5: R2 cost wording, no check or upload as a verb or noun, one 23.5-hour reconcile limit, FILTER keeps the subtree and /timestamp. Fact check note: LIST_FLOOR stops a listing that does not have more than 15,000 lines. Canonical change and root-vars lines. Minors: verbs in the ledes, list and accepts, through, vertical lists, revision-number wording, lede split, runbook bullets trimmed to tlnet specifics, elliptical forms, caution order, step 1 tools, subtree for tree, the UUID sentence, quoted link text.
task plan does steps, it does not only show (list, state, diff and split write to .run/). Linter: no copy as a verb, number of bytes for size, no count as a noun, uploads only the changes, schedules a run, the subkey that signs, tlmgr downloads for request. Kept as names: Is it fresh?, mirror rotation, Writing, When a run fails, Want your own?, and the canonical root-vars line (19 words by Rule 8.5).
@jshvn
jshvn merged commit 90589ee into main Oct 9, 2026
1 check passed
@jshvn
jshvn deleted the josh/docs-ste branch October 9, 2026 01:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant