Site Discovery
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/site-discovery |
| Package slug | site-discovery |
| Product group | Capell Search & SEO |
| Tier | premium |
| Bundle | search-seo |
| Runtime contexts | admin, frontend, console |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/site-discovery |
| Docs source | packages/site-discovery/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Site Discovery is an Available, No schema impact Capell package in the Capell Search & SEO product group. It ships as capell-app/site-discovery and extends these surfaces: admin, frontend, console.
Make every published Capell page discoverable with automatic XML sitemaps, an HTML sitemap, and the canonical public-URL registry that powers the Search & SEO bundle.
After install, admins get package-owned management surfaces and public users may see package-owned frontend output or routes.
Status details:
- Status: Available
- Tier: premium
- Bundle: search-seo
- Composer package:
capell-app/site-discovery - Namespace:
Capell\SiteDiscovery - Theme key: not applicable
Why It Matters
Section titled “Why It Matters”For developers: The package gives developers package-owned service providers, Actions, Data objects, Laravel routes, Filament classes, and Blade views instead of pushing this behaviour into core or application code.
For teams: Make every published Capell page discoverable - automatic XML sitemaps with index sharding, an HTML sitemap, and the canonical public-URL registry that powers the whole Search & SEO bundle.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
- Page resource sitemap action (admin, required).
- Site resource sitemap action (admin, required).
- Sitemap generation tool (admin, required).
- Public HTML sitemap page (frontend, required).
- Generated XML sitemap output (frontend, required).
- Public URL Registry parity page (admin, required).
- Public URL Registry quality report (admin, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\SiteDiscovery\Providers\SiteDiscoveryServiceProvider. - Config files:
packages/site-discovery/config/capell-site-discovery.php. - Filament classes:
SitemapResourceHeaderActionExtender,SitemapSiteHeaderActionExtender,SitemapSiteRecordActionExtender,PublicUrlRegistryPage. - Livewire components:
Sitemap,SitemapTool. - Route files:
packages/site-discovery/routes/web.php. - Listeners:
RegenerateSitemapsOnPageDeleted,RegenerateSitemapsOnPageSaved,RegenerateSitemapsOnSiteCreated. - Actions:
BuildGeneratedOutputParityReportAction,BuildPublicSitemapTreeAction,BuildPublicUrlRegistryAction,BuildSitemapXmlResponseAction,DiscoverPublicDiscoveryOutputsAction,DiscoverPublicPagesAction,DiscoverPublicUrlsAction,GenerateSitemapAction,NotifyPageUrlChangesAction,NotifyPublicUrlChangesAction,RedactIndexNowNotificationErrorMessageAction,RequestSiteSitemapRegenerationAction,and 1 more. - Data objects:
DiscoverablePageData,DiscoverableUrlData,DiscoveryOutputData,GeneratedOutputParityReportData,GeneratedOutputParityRowData,PublicUrlData,PublicUrlRegistryEntryData,SiteMapData,SitemapAlternateData,SitemapImageData,SitemapNewsData,SitemapPageData,and 5 more. - Jobs:
RegenerateSiteSitemapIncrementallyJob. - Command signatures:
capell:xml-sitemap. - Console command classes:
XmlSitemapCommand. - Manifest contributions:
admin-page: Capell\SiteDiscovery\Manifest\PublicUrlRegistryPageContribution,route: Capell\SiteDiscovery\Manifest\SiteDiscoveryFrontendRoutesContribution,scheduled-job: Capell\SiteDiscovery\Manifest\SiteDiscoveryIncrementalSitemapScheduleContribution. - Health checks:
Capell\SiteDiscovery\Health\SiteDiscoveryHealthCheck. - Blade views:
packages/site-discovery/resources/views/components/pages/sitemap.blade.php,packages/site-discovery/resources/views/components/pages/sitemap/page.blade.php,packages/site-discovery/resources/views/filament/pages/public-url-registry.blade.php,packages/site-discovery/resources/views/livewire/page/sitemap.blade.php,packages/site-discovery/resources/views/livewire/tools/sitemap-tool.blade.php,packages/site-discovery/resources/views/sitemap/sitemap-page.blade.php. - Cache tags:
site-discovery.
Data Model
Section titled “Data Model”This package has no schema impact. It does not declare package-owned migrations or required tables.
Docs gap: document extension points here if the package delegates persistence to a host package.
Install Impact
Section titled “Install Impact”- Admin navigation: adds package-owned Filament classes when registered.
- Permissions:
View:PublicUrlRegistryPage. - Public routes: route files exist and must be reviewed before public enablement.
- Database changes: no package migrations declared.
- Settings: no package settings declared.
- Queues or schedules: review package jobs or schedules before install.
- Cache tags:
site-discovery. - Commands:
capell:xml-sitemap.
Common Pitfalls
Section titled “Common Pitfalls”- Review route middleware, throttling, signed URLs, and public-output safety before exposing routes.
- Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
- Run package commands from the host app; in this repository use
vendor/bin/pestfor package tests. - Keep
composer.json,composer.local.json,capell.json, docs, screenshots, and tests aligned when the package surface changes.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Check | Fix |
|---|---|---|---|
| Package surface is missing after install | Provider or manifest is not loaded | Confirm capell.json, package composer.json, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |
| Route returns unexpected output | Route cache, middleware, or signed URL setup does not match the package route file | Check the route files listed in Technical Shape | Clear route cache and verify middleware before exposing public routes |
| Background work does not run | Queue worker or scheduled command is not active | Check package jobs, commands, and host scheduler configuration | Start the queue or scheduler, then run the focused command or package test |
| Public output leaks unexpected state | Render data, cache variation, or authoring boundary has regressed | Check public Blade, cache tags, and public-output safety tests | Move data loading out of Blade and rerun the package public-output tests |
Quick Start
Section titled “Quick Start”- Install the package:
composer require capell-app/site-discovery. - Run the required setup: no package migrations are declared; clear cached config and routes if the host app uses caches.
- Open the related Capell admin surface and verify Site Discovery appears.
Next Steps
Section titled “Next Steps”- Package docs
- Overview
- Screenshot contract
- Marketplace assets
- Capell content language plan
- Capell documentation design system
- Capell and package ERD notes
- Related packages: Agent Delivery, Search, Seo Suite, Url Manager.
- Focused tests:
vendor/bin/pest packages/site-discovery/tests --configuration=phpunit.xml.