docs: Sprint 2.5 - Namespace Architecture Documentation Updates#44
Merged
docs: Sprint 2.5 - Namespace Architecture Documentation Updates#44
Conversation
- Update events.md to show namespace auto-detection examples - Show override patterns for explicit namespace control - Update resources.md with namespace configuration examples - Demonstrate plugin slug auto-detection (e.g., acme-blog.*) - Clarify framework vs application event branding Prepares documentation for Sprint 2.5 namespace architecture fix. Related: #43
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for Sprint 2.5, introducing namespace architecture changes that enable automatic namespace detection based on plugin context. The changes prepare the documentation for upcoming implementation while maintaining WP Kernel's zero-ceremony philosophy.
Key changes:
- Added namespace auto-detection examples showing plugin-specific event naming (e.g.,
acme-blog.*instead ofwpk.*) - Documented explicit namespace override patterns for advanced use cases
- Clarified separation between framework events (
wpk.*) and application events (plugin-specific)
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/guide/resources.md | Added namespace auto-detection examples and explicit override patterns for defineResource |
| docs/guide/events.md | Updated event naming examples to show namespace auto-detection and framework vs application event separation |
Comments suppressed due to low confidence (1)
docs/guide/resources.md:1
- Inconsistent event naming examples. These lines still show 'wpk.thing.' namespace, but should reflect the new namespace auto-detection pattern established earlier in the document (e.g., 'acme-blog.thing.').
# Resources
docs/guide/events.md
Outdated
| addAction('wpk.cache.invalidated', 'my-plugin/debug', (payload) => { | ||
| console.log('Cache invalidated:', payload.keys); | ||
| }); | ||
|
|
There was a problem hiding this comment.
Inconsistent markdown code block delimiters. Line 148 uses four backticks (`````) while line 160 uses four backticks where three should be used (```).
Co-authored-by: Copilot <[email protected]> Signed-off-by: Jason Joseph Nathan <[email protected]>
…tion - Update main README with namespace auto-detection patterns - Fix hardcoded wpk.* references in package READMEs - Update API docs and guides with namespace examples - Clarify framework vs user event namespacing - Complete Sprint 2.5 Task 1 documentation requirements
…nts guide - Remove incorrect opening markdown delimiter at file start - Fix inconsistent 4-backtick usage throughout the file - Ensure all code blocks use standard 3-backtick delimiters - Remove wrapping markdown block around final section - All 8 code blocks now properly paired with matching delimiters Resolves markdown parsing issues in docs/guide/events.md
pipewrk
added a commit
that referenced
this pull request
Oct 3, 2025
- Creates 7 issues for remaining Sprint 2.5 tasks (Tasks 2-8) - Task 1 (Documentation) already completed via PR #44 - Covers namespace architecture implementation (Tasks 2-6) - Includes Sprint 2 completion work (Tasks 7-8) - Ready to create milestone and issues for 3-day sprint Usage: ./scripts/create-sprint-2.5-issues.sh
pipewrk
added a commit
that referenced
this pull request
Nov 8, 2025
…dates docs: Sprint 2.5 - Namespace Architecture Documentation Updates
pipewrk
added a commit
that referenced
this pull request
Nov 8, 2025
- Creates 7 issues for remaining Sprint 2.5 tasks (Tasks 2-8) - Task 1 (Documentation) already completed via PR #44 - Covers namespace architecture implementation (Tasks 2-6) - Includes Sprint 2 completion work (Tasks 7-8) - Ready to create milestone and issues for 3-day sprint Usage: ./scripts/create-sprint-2.5-issues.sh
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
This PR contains the documentation updates for Sprint 2.5 (Namespace Architecture Fix). These changes prepare the documentation for the upcoming namespace auto-detection implementation.
Changes Made
Public Documentation Updates
docs/guide/events.md:
acme-blog.*instead ofwpk.*)docs/guide/resources.md:
defineResourceDocumentation Philosophy
These changes maintain WP Kernel's zero-ceremony approach while showing users they can:
defineResource- namespace auto-detectedwpknamespaceRelated Work
information/sprints/(not tracked in git)Next Steps
After this PR merges:
new Function()usage)Impact