adopt loomctl's guarantees, and generate the sidebar from the locks
The sidebar named its four sections by hand, so adopting from a new repository needed a config edit — a second place to update, which is exactly what the autogenerated directories were already avoiding one level down. It is written from the locks now and astro.config.mjs names nothing. guarantees.usages.md is the first usages facet here with a short real answer, because this site is built with the tool: check-reports-does-not-fix is what lets npm run check run in CI, and the etag being the publisher's verbatim is what the guide stamps are. It also records what we lean on that the page explicitly does not promise — the command surface, quoted in our README. A renamed command breaks our documentation and not our build, and no check will catch it, because the thing that moved is not a document we adopted. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,93 @@
|
||||
# What `loomctl` guarantees
|
||||
|
||||
**Not what it does — `--help` says that, and the commands will change.** *This is
|
||||
what will keep being true while they do.*
|
||||
|
||||
---
|
||||
|
||||
## It grants no access, and records where the copy came from
|
||||
|
||||
**`loomctl` reads what your credentials already let you read.** *Everything it
|
||||
does is possible with copy and paste.* **It is a mast, not a lock** — *the point
|
||||
is to make the wrong thing deliberate, not impossible.*
|
||||
|
||||
> **What it adds over a paste is provenance.** *A pasted document cannot answer
|
||||
> "where did this come from, and were we allowed to have it" — not because the
|
||||
> question is hard, but because the evidence is gone.*
|
||||
|
||||
## It never writes over the network
|
||||
|
||||
**No push, no publish, no `POST`, no token that needs write scope.** *Every byte
|
||||
it writes is a file in your working tree.* **Committing and pushing are yours**,
|
||||
*because the consequences of a push land on people a tool cannot experience.*
|
||||
|
||||
**A credential given to `loomctl` should never carry write scope**, *and if one
|
||||
does, nothing here will use it.*
|
||||
|
||||
## Freshness is a conditional request against the publisher's `ETag`
|
||||
|
||||
**Stored verbatim, opaque, never a hash we compute.** *A fetch that normalises
|
||||
anything breaks a local digest and reports a change that did not happen.*
|
||||
|
||||
*This is `externals`' rule and `loomctl` is a second holder of it. **It is stated
|
||||
here so that the tool holding it is a fact somebody can find**, and so that
|
||||
breaking it is visible rather than silent* — **a specimen was written in this
|
||||
repository that computed a hash instead, and it was wrong within a day.**
|
||||
|
||||
**The URL in a lock is resolved.** *A short form follows whatever the default
|
||||
branch is at the time you ask, so a branch rename would report as a change in the
|
||||
document.*
|
||||
|
||||
## It reports; it does not repair
|
||||
|
||||
**Nothing is overwritten.** *A document that moved upstream is written to a
|
||||
staging area as a candidate, and taking it is a separate act.* **A local copy
|
||||
that differs from what the publisher serves is left alone** — *it is the only
|
||||
evidence that something changed while nothing was watching.*
|
||||
|
||||
**`add` adopts what is absent and refuses what is already adopted.** *A document
|
||||
that is present but unlocked is locked only when the bytes are identical to what
|
||||
the publisher serves*, **so a lock's claim — this copy is the one being served —
|
||||
is verified rather than assumed.**
|
||||
|
||||
## The lock file
|
||||
|
||||
**`.loom/externals/.locks`, one record per adopted document, tab-separated,
|
||||
ordered by path.**
|
||||
|
||||
```
|
||||
path <TAB> url <TAB> etag [ <TAB> visibility ]
|
||||
```
|
||||
|
||||
- **`path`** — *relative to `.loom/externals/`, and **for a person to read**.* **It
|
||||
does not round-trip to a URL**; *it drops the route, the branch, and the
|
||||
publisher's `.loom/published/`.*
|
||||
- **`url`** — *the resolved origin, branch and all.*
|
||||
- **`etag`** — *the publisher's, verbatim, including its quotes.*
|
||||
- **`visibility`** — *optional. What the source could be read as **when it was
|
||||
fetched**: `public` or `not-public`.* **Never `private`** — *an anonymous
|
||||
request tells those two apart and nothing finer.*
|
||||
|
||||
**Records with three fields remain valid.** *A repository does not stop working
|
||||
because the tool learned something new.*
|
||||
|
||||
## What is not promised
|
||||
|
||||
**The command surface.** *Names, flags and output are `--help`'s business and may
|
||||
change. Nothing should parse them.*
|
||||
|
||||
**The generated orientation file's format.** *It is byte-deterministic within a
|
||||
version so that its diff is readable; it is not stable across versions.*
|
||||
|
||||
**That visibility is precise.** *The signal distinguishes public from not-public
|
||||
and nothing finer, so it cannot see two repositories private to different people
|
||||
— which is the case where adopting between private repositories genuinely widens
|
||||
access.* **The tool says so where it reports it, rather than implying a verdict it
|
||||
has not earned.**
|
||||
|
||||
**That anything is checked when you are not looking.** *Nothing here runs on a
|
||||
schedule, and a document nobody checks is a document nobody is checking.*
|
||||
|
||||
---
|
||||
|
||||
*Verified fetchable by somebody who is not us on 2026-09-08.*
|
||||
@@ -0,0 +1,27 @@
|
||||
# Usages — `loomctl` guarantees
|
||||
|
||||
**This site is built with the tool.** *Every reference page in it was adopted with
|
||||
`external add`, and the reconcile that produced this one went through `check` and
|
||||
`apply`.* **So "what of ours depends on it" has a short, real answer for once.**
|
||||
|
||||
| what the page guarantees | what of ours leans on it |
|
||||
|---|---|
|
||||
| `check` reports and does not fix | **`npm run check` in CI.** *A build that repaired what it found would commit on a runner, with no cart and nobody to decide* |
|
||||
| the `ETag` is the publisher's, verbatim | `scripts/generate.mjs` — *the guide stamps in frontmatter are those etags; a computed hash would fire the stale banner on every whitespace change* |
|
||||
| it never writes over the network | *the deploy holds no write credential — `git-sync` clones anonymously and `loomctl` is never on the cluster at all* |
|
||||
| `add` refuses what is adopted, and stages a differing copy | *how all eight original documents were locked after being fetched by hand, without one byte being rewritten* |
|
||||
|
||||
## What we depend on that the page explicitly does not promise
|
||||
|
||||
**The command surface.** *`scripts/publish-site.sh` and the README quote
|
||||
`loomctl external add loom/<repo> <doc>.md` verbatim.* **The page says names,
|
||||
flags and output are `--help`'s business and nothing should parse them** — *we do
|
||||
not parse them, but a person following our README will type them.*
|
||||
|
||||
> **So a renamed command breaks our documentation and not our build**, *and no
|
||||
> check will catch it*, **because the thing that moved is not a document we
|
||||
> adopted.**
|
||||
|
||||
*Recorded rather than solved. It is the same class as the sub-page staleness limit
|
||||
in `HANDOFF.md`: the lock watches documents, and some of what we lean on is not a
|
||||
document.*
|
||||
Reference in New Issue
Block a user