Repository navigation
chore: docs audit - #35
Merged
Merged
Conversation
Revise every file in docs/ against the code, add a docs index and writing rules, and a CI check that keeps the markdown pointing at things that exist.
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.
An audit of
docs/: every claim checked against the code, croc v11.5.4's source, the CI config and GitHub, then rewritten so it stays true and reads plainly. Docs now hold current facts only: no dates, no planning IDs, no history.Docs
CrocEngineis off limits;TransferEventhas.stored; the Advanced options are wired end to end;.xcode-versionis 27.1; the nullability warning is fixed, not "expected"; store function signatures; UI labels spelled as the app spells them.CHANGELOG.md[1.0.0], the landing page,llms.txtand the docs site said otherwise.docs/README.mdindexes every doc, replacingdocs/knowledge/README.md.docs/RELEASING.mdtakes signing, notarization, Sparkle, App Store uploads and a repeatable release checklist out ofBUILDING.md. The one-off setup log is now a "One-time setup" how-to.docs/knowledge/landing-page.md, plus a test-suite map inBUILDING.md.design/names the version a fact was checked against instead of a date.known-issues.md:CONTRIBUTING.mdregains its "Verification" and "Docs" sections, which its contents table linked to. The README's dead#build-from-sourceanchor is fixed.Keeping docs true
docs/AGENTS.md: where each kind of fact goes and how to write it.AGENTS.md: a "Verification" rule, and a "Docs" map from each area of code to the docs it must keep in step.scripts/verify-docs.sh(bash and POSIX awk) checks every tracked markdown file outside the docs site:docs/and theAGENTS.mdfiles only: dates, planning IDs and section-number citationsdocs checksjob that runs on every push and PR: renaming any file can break a path a doc names. It is part ofci pass.Code
crocmobile/session.go: a delegate panic inOnCodeReadyduring a text send no longer leaves the text temp file behind.TestNetworkGlobalsRestoredAfterPanicnow asserts it, and it fails without the fix.CodeField: the paste button's 38 pt figure was a claim nothing set. SwiftUI lets an app set only aPasteButton's border shape, label style and tint, so its size is the system's. The docs now say that, and measuring it is listed in the open accessibility audit.AutoVerify.swift's header lists--transport.crocmobile/osv-scanner.tomlnames the x/crypto packages croc really imports.Verification
scripts/verify-docs.sh: PASS, 48 markdown files, locally and in CI. Its first CI run caught a wrong path in a doc that was still untracked locally, so the script now scans uncommitted docs too. Also passes withCrocKit/Croc.xcframeworkand.tools/removed (fresh-clone case).scripts/verify-design.sh: OK.shellcheck -x scripts/*.sh: clean.scripts/format-swift.sh --lint: PASS.crocmobile/:go build,go vet,go test -race ./...ok,golangci-lint run0 issues.xcodebuildiOS Simulator build and macOStest, both with warnings as errors (TEST SUCCEEDED);CrocApp Directbuild;swift test --package-path CrocKit(35 tests passed).scripts/assemble-site.sh: builds, and the docs site fails on any broken link.AI assistance: substantial