Notes
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/notes |
| Package slug | notes |
| Product group | Capell Collaboration |
| Tier | premium |
| Bundle | collaboration |
| Runtime contexts | admin |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/notes |
| Docs source | packages/notes/docs |
| Manifest | capell.json |
Contextual notes, assignments, mentions, and reminders for Capell.
At A Glance
Section titled “At A Glance”- Package:
capell-app/notes - Namespace:
Capell\Notes\ - Surfaces: Filament admin, database
- Service providers:
packages/notes/src/Providers/AdminServiceProvider.php,packages/notes/src/Providers/NotesServiceProvider.php - Capell dependencies:
capell-app/admin
Why It Helps Your Capell Workflow
Section titled “Why It Helps Your Capell Workflow”- Adds contextual notes, assignments, mentions, and reminders to supported Capell admin records.
- Helps editors coordinate review work inside the CMS instead of moving comments into chat or spreadsheets.
- Fits publishing and operations workflows where the record itself should carry the next action and accountability.
Best Used With
Section titled “Best Used With”What It Adds
Section titled “What It Adds”- Contextual notes, assignments, mentions, and reminders for Capell.
- An admin inbox for operational follow-up that stays separate from public page output.
- Package-owned note, assignment, mention, and reminder records.
Code Map
Section titled “Code Map”| Area | Path | Purpose |
|---|---|---|
| Actions | packages/notes/src/Actions | Domain operations. Test these directly where possible. |
| Data | packages/notes/src/Data | Structured payloads, form state, view models, and integration data. |
| Enums | packages/notes/src/Enums | Persisted states and Filament option values. |
| Models | packages/notes/src/Models | Eloquent records owned by the package. |
| Filament | packages/notes/src/Filament | Admin resources, pages, widgets, and settings UI. |
| Providers | packages/notes/src/Providers | Registration, extension hooks, routes, migrations, and resources. |
| Resources | packages/notes/resources | Views, translations, assets, and package resources. |
| Database | packages/notes/database | Migrations, seeders, and settings migrations. |
| Tests | packages/notes/tests | Package-level Pest coverage. |
Admin Surface
Section titled “Admin Surface”- Pages:
NotesInboxPage.
Data And Persistence
Section titled “Data And Persistence”- Models:
Note,NoteAssignment,NoteMention,NoteReminder. - Migrations:
2026_05_10_190862_01_create_notes_tables.php. - Data objects live in
src/Data/; use them for payloads, form state, and view models.
Extension Points
Section titled “Extension Points”- Register Capell extension points, routes, migrations, settings, render hooks, and resources from service providers.
Install And Setup
Section titled “Install And Setup”- Install with
composer require capell-app/notesin the host Capell application. - Run migrations through the host application package install flow.
- In this repository, verify package changes with
vendor/bin/pest; do not usephp artisan.
Testing
Section titled “Testing”Run package tests from the repository root:
vendor/bin/pest packages/notes/tests --configuration=phpunit.xmlMaintenance Notes
Section titled “Maintenance Notes”- Put behaviour changes in
src/Actions/; UI classes, commands, and controllers should call actions instead of owning domain logic. - Use package
Dataclasses at boundaries instead of passing anonymous arrays between layers. - Use backed enums for persisted values and enum labels for Filament options.