Skip to content

📝 Consolidate and update development documentation#1076

Merged
0x46616c6b merged 4 commits intomainfrom
consolidate-development-docs
Feb 27, 2026
Merged

📝 Consolidate and update development documentation#1076
0x46616c6b merged 4 commits intomainfrom
consolidate-development-docs

Conversation

@0x46616c6b
Copy link
Member

Summary

  • Consolidate docs/development/ from 7 pages down to 5 focused pages
  • Remove outdated content (Octicons v9 references, wrong make cs-fixer command, stale Dovecot IP allowlist setup)
  • Add missing context about project architecture, background services, and Dovecot integration testing

Changes

Pages rewritten or created

  • Getting started (index.md): Added tech stack intro, service table (incl. webhook tester), project structure overview, key entities, patterns, templates (Heroicons/UX Icons), background services (worker, scheduler), and logs section (integrated from logs.md)
  • Contributing (contributing.md): New page consolidating Code of Conduct reference, corrected coding style commands (composer cs-fix/check, Rector, Psalm), commit/PR conventions, and translation workflow
  • Testing (testing.md): PHPUnit/Behat with tabbed direct/make commands, expanded Dovecot integration section covering Behat API tests and manual container testing
  • Release (release.md): Added prerequisites (CHANGELOG date validation), full script output description, Docker image publishing info

Pages removed

File Reason
icons.md Referenced Octicons v9 which are no longer used (project uses Heroicons)
logs.md Integrated into Getting started
coding_style.md Integrated into Contributing, fixed incorrect make cs-fixer reference
tests.md Replaced by testing.md

Other changes

  • docker-compose.yml: Fixed subnet to 10.89.0.0/24 for deterministic container networking
  • mkdocs.yml: Updated navigation to match new page structure

The changes and the PR were generated by OpenCode.

@0x46616c6b 0x46616c6b marked this pull request as ready for review February 27, 2026 16:37
0x46616c6b and others added 2 commits February 27, 2026 18:25
Rewrite docs/development/ from 7 pages to 5 focused pages with accurate,
up-to-date content. Remove outdated information and add missing context
about project architecture, background services, and Dovecot integration testing.

Co-Authored-By: OpenCode <noreply@opencode.ai>
Co-Authored-By: OpenCode <noreply@opencode.ai>
@0x46616c6b 0x46616c6b force-pushed the consolidate-development-docs branch from 00d3d53 to 2f71848 Compare February 27, 2026 17:25
Copy link
Contributor

@y3n4 y3n4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it 😍 Just a few nitpicks

0x46616c6b and others added 2 commits February 27, 2026 19:59
Co-authored-by: yena <116947881+y3n4@users.noreply.github.com>
@sonarqubecloud
Copy link

@0x46616c6b 0x46616c6b merged commit eaec5d4 into main Feb 27, 2026
9 checks passed
@0x46616c6b 0x46616c6b deleted the consolidate-development-docs branch February 27, 2026 19:08
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.

2 participants