docs: comprehensive README with gradual discovery#89
Open
Conversation
added 2 commits
February 10, 2026 21:58
- Updated for Craft 5 / PHP 8.2+ requirements - Organized with progressive complexity: overview → install → config → events → extending - Added complete event reference tables (content, user, permission, schema, system) - Added configuration reference with all settings and defaults - Added extending section (snapshot events, permissions, template variables) - Added upgrade guide from Craft 4 - Added console commands documentation
- Events reference table (10 events across 6 categories) - Code examples for 3 most common use cases: 1. Cancel logging (EVENT_BEFORE_LOG — skip bot traffic) 2. Register custom events (EVENT_REGISTER_EVENT_TYPES — Commerce) 3. Filter by element type (EVENT_DEFINE_SHOULD_LOG — skip Assets) - Links to docs/events.md for full reference - Preserves existing EVENT_SNAPSHOT example
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
1 participant
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
Rewrites the README with a gradual discovery structure — readers start with the simplest overview and progressively encounter more detail.
Structure
Changes