LotusGuild/tinker_tickets
4
0
Fork 0
Code Issues 46 Pull Requests Actions Packages Projects Releases Wiki Activity

README.md Project Structure tree is stale (missing error views, config/requirements.php, migration 001) #45

New Issue
Open
opened 2026-08-31 21:29:48 -04:00 by jared · 0 comments
jared commented 2026-08-31 21:29:48 -04:00
Owner
Copy Link
Copy Source

Severity: Docs

A few small staleness gaps found while cross-checking README.md against the actual file tree:

  • views/error_403.php and views/error_404.php exist but aren't listed in the Project Structure tree (README.md ~lines 399-412 only lists CreateTicketView.php, DashboardView.php, layout_footer.php, layout_header.php, TicketView.php, admin/).
  • config/requirements.php exists but isn't listed under config/ (only config.php is shown) — worth also confirming it isn't a duplicate/older copy of the already-documented scripts/check_requirements.php.
  • migrations/001_widen_bulk_operations_status.sql isn't mentioned anywhere — the Database Schema / Migrations section only describes 000_baseline.sql and migrate.php generically. Technically not wrong, but gives no hint a second migration file exists; a reader following just the README would run baseline and assume they're fully up to date.

Fix: Update the Project Structure tree and Database Schema section to reflect these files.

**Severity:** Docs A few small staleness gaps found while cross-checking README.md against the actual file tree: - `views/error_403.php` and `views/error_404.php` exist but aren't listed in the Project Structure tree (README.md ~lines 399-412 only lists `CreateTicketView.php`, `DashboardView.php`, `layout_footer.php`, `layout_header.php`, `TicketView.php`, `admin/`). - `config/requirements.php` exists but isn't listed under `config/` (only `config.php` is shown) — worth also confirming it isn't a duplicate/older copy of the already-documented `scripts/check_requirements.php`. - `migrations/001_widen_bulk_operations_status.sql` isn't mentioned anywhere — the Database Schema / Migrations section only describes `000_baseline.sql` and `migrate.php` generically. Technically not wrong, but gives no hint a second migration file exists; a reader following just the README would run baseline and assume they're fully up to date. **Fix:** Update the Project Structure tree and Database Schema section to reflect these files.
jared added the documentationpriority/docs labels 2026-09-08 10:15:45 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
api
Bearer/internal API surface
 bug
Something is not working
 concurrency
Race condition / concurrency bug
 config
Configuration / deployment default
 data-integrity
Data correctness / schema / integrity issue
 dead-code
Unused / dead code cleanup
 documentation
README / docs accuracy
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 needs-decision
Needs a maintainer decision, not clearly a bug
 notifications
Matrix / in-app notification bug
 performance
Performance or resource-usage concern
 priority/docs
Documentation-only gap
 priority/high
High-severity / high-impact issue
 priority/low
Low-severity / cosmetic issue
 priority/medium
Medium-severity issue
 question
More information is needed
 rate-limiting
Rate limiting behavior
 reliability
Reliability / error-handling gap
 security
Security or access-control impact
 ux
User-facing UX/functional bug
 wontfix
This won't be fixed
 workflow
Ticket status workflow engine
No labels documentation priority/docs
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
cole (Cole Keller) jared (Jared Vititoe) nathan (Nathan Vititoe)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: LotusGuild/tinker_tickets#45