docs: correct 18 verified inaccuracies against mantis main - #7
Open
adamXbot wants to merge 1 commit into
Open
Conversation
Reference pages had fallen systematically behind the source.
Wrong
- The documented Docker quickstart fails. docker-compose.yml requires
POSTGRES_PASSWORD via ${POSTGRES_PASSWORD:?...} and .env.example ships it
empty, so `cp .env.example .env && docker compose up -d` exits 1 at
interpolation. The supported path, ./scripts/setup.sh, was mentioned nowhere.
Fixed in docker-local, trying-locally and tailscale, and POSTGRES_PASSWORD
added to configuration's Required list.
- "13 server-backed artifacts" — 22 formats ship. The nine missing ones are the
credential and config-store baits (rtf, cookies, bookmarks, env,
aws-credentials, netrc, kubeconfig, ovpn, rdp). The route's own error message
lists all 22.
- The placeholder body text quoted in file-keys does not exist. DEFAULT_BODY is
a multi-paragraph fake memo, and a regression test forbids the word
"placeholder" because the old default gave the canary away. It also applies
to 8 of 19 generators, not all of them.
- Notification channels are six, not five — home_assistant was missing, and
host-events already told readers to use it.
- architecture.md described a src/middleware.ts that does not exist; proxy.ts
is the Next 16 entrypoint and having both would be a build error.
Also corrected the enroll-key scope claim in api.md and single-user.md. An
enroll key is not blind to everything it did not create — it can read back keys
matching its own external_id — so the boundary is now stated as it is in the
code rather than more strongly.
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
1 participant
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.
Every claim was checked against source, then through three independent review passes (audit → apply → review caught 20 new errors → correct → strict re-read caught 18 more → patch + manual).
node scripts/check-docs.mjspasses. This site cleared the final gate with zero remaining problems.The documented Docker quickstart fails.
docker-compose.ymlrequiresPOSTGRES_PASSWORDvia${POSTGRES_PASSWORD:?…}and.env.exampleships it empty, socp .env.example .env && docker compose up -dexits 1 at interpolation. The supported path —./scripts/setup.sh— was mentioned nowhere on the site. Fixed indocker-local,trying-locallyandtailscale.Nine file formats were missing. The docs say 13 server-backed artifacts; 22 ship. The absent nine are the credential and config-store baits —
rtf,cookies,bookmarks,env,aws-credentials,netrc,kubeconfig,ovpn,rdp. The route's own error message lists all 22.The quoted placeholder body text does not exist.
file-keys.mdquotesCONFIDENTIAL DRAFT — do not distribute.;DEFAULT_BODYis a multi-paragraph fake memo, and there is a regression test forbidding the word "placeholder" precisely because the old default gave the canary away. The docs were reintroducing the bug in prose.Also:
home_assistantwas missing from the notification channels (five listed, six exist) thoughhost-events.mdalready told readers to use it; andarchitecture.mddescribed asrc/middleware.tsthat does not exist —proxy.tsis the Next 16 entrypoint and having both would be a build error.One correction worth noting because it went the other way: the enroll-key scope claim was made too strong by the fix pass ("can see nothing, not even the keys it created"). An enroll key can read back keys matching its own
external_id. Now stated as the code has it.