Skip to content

Consolidate folder structure and conventions documentation#8200

Merged
dereuromark merged 2 commits into5.xfrom
conventions-rewrite
Jan 30, 2026
Merged

Consolidate folder structure and conventions documentation#8200
dereuromark merged 2 commits into5.xfrom
conventions-rewrite

Conversation

@josbeir
Copy link
Contributor

@josbeir josbeir commented Jan 29, 2026

Merged cakephp-folder-structure.md and conventions.md into a single comprehensive Structure & Conventions guide.

Changes:

  • Combined two separate pages (798 lines → 369 optimized lines) into /intro/conventions
  • Added VitePress enhancements for better readability:
    • 6 collapsible sections to reduce initial page length (~40%)
    • 3 tabbed code groups showing correct vs incorrect examples
    • 6 alert containers (TIP/WARNING/NOTE) for critical information
  • Added documentation links to all folder descriptions in src/ directory table
  • Updated TOC to reflect single consolidated entry
  • Removed duplicate content and legacy HTML tables

Benefits:

  • Single source of truth for CakePHP conventions
  • Improved navigation with consistent cross-references
  • Progressive disclosure reduces cognitive load for new developers
  • Better visual learning through side-by-side code comparisons

All markdown validated with zero errors.

@dereuromark dereuromark requested a review from ADmad January 29, 2026 09:50

This comment was marked as outdated.

@josbeir josbeir requested a review from dereuromark January 30, 2026 05:46
@dereuromark dereuromark merged commit 879a8fc into 5.x Jan 30, 2026
5 checks passed
@dereuromark dereuromark deleted the conventions-rewrite branch January 30, 2026 07:15
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.

3 participants