Repository navigation
Correct 30 documentation statements found by checking each page against the code - #27
Merged
Merged
Conversation
…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.
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.
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
SettingsExceptionsubclasses, six models (four with factories), 18 abilities withprunelisted.reencryptof history, persisted configuration, and the eleven abilities said to be reserved.null; the tenant column is binary-collated on three tables, not all; inheritance of keys whose definition does not say.viewandforgetgates too; missing imports in the fake example;register()on a definition example; spatie typed classes must be listed intyped.classes; diff output buckets; key normalisation;because()given a string; step-up over REST.AuditActioncases, auditmetakeys,Services\Transfer, tables the migration creates, shared tablesmake-store --connectioncreates (help text fixed too).Local: 748 tests (including the reference-docs and Mermaid guards), Pint and PHPStan clean.