Skip to content

Correct 30 documentation statements found by checking each page against the code - #27

Merged
imanimanyara merged 1 commit into
mainfrom
docs/accuracy-audit
Nov 16, 2026
Merged

imanimanyara merged 1 commit into
mainfrom
docs/accuracy-audit

Conversation

@imanimanyara

Copy link
Copy Markdown
Member

Summary

Owner asked for the README and docs to be updated and checked thoroughly for accuracy.

Method. Four read-throughs covering the README and all 55 docs pages, each claim checked against src/, config/settings.php, routes/ and the migration. Every finding was re-verified against the code before changing the page. A mechanical pass checked 326 internal links and their anchors, every page footer, 62 class references, 19 command names, config keys in backticks, the README index (all 55 pages listed) and its badges.

Corrections (30), by kind

  • Stale counts: 18 commands (not 19), 29 SettingsException subclasses, six models (four with factories), 18 abilities with prune listed.
  • Shipped features described as future: approvals, reencrypt of history, persisted configuration, and the eleven abilities said to be reserved.
  • Behaviour: a global runtime override reaches owners only when the setting inherits (three places); encrypted history payloads are null; the tenant column is binary-collated on three tables, not all; inheritance of keys whose definition does not say.
  • Recipes: the preferences screen needs view and forget gates too; missing imports in the fake example; register() on a definition example; spatie typed classes must be listed in typed.classes; diff output buckets; key normalisation; because() given a string; step-up over REST.
  • Lists: AuditAction cases, audit meta keys, Services\Transfer, tables the migration creates, shared tables make-store --connection creates (help text fixed too).
  • SQL Server: the stated reason (NULLs in a unique index) was wrong; no unique index has a nullable column. It is unsupported because it is not in the test matrix.

Local: 748 tests (including the reference-docs and Mermaid guards), Pint and PHPStan clean.

…st the code

Four read-throughs of the README and all 55 docs pages, each finding verified against src, config, routes and the migration before changing it. Links (326), anchors, footers, class names, commands and config keys were also checked mechanically.
@imanimanyara
imanimanyara merged commit 9c68d26 into main Nov 16, 2026
14 checks passed
@imanimanyara
imanimanyara deleted the docs/accuracy-audit branch November 16, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant