Skip to content
Capell CMS

Site Discovery

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/site-discovery
Package slug site-discovery
Product group Capell Search & SEO
Tier free
Bundle search-seo
Runtime contexts admin, frontend, console
Capell version ^1.0
Catalogue role extension
Release channel Beta
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.

Site Discovery builds a canonical public-URL registry plus XML and HTML sitemap output from published, indexable Capell content.

Admins can inspect which public URLs are indexable and covered by generated outputs. Search engines and other crawlers receive current sitemap routes as content changes.

Evidence: src/Actions/BuildPublicUrlRegistryAction.php, src/Actions/GenerateSitemapAction.php, src/Actions/BuildSitemapXmlResponseAction.php, tests/Feature/SitemapXmlRouteTest.php, src/Filament/Pages/PublicUrlRegistryPage.php, tests/Feature/Filament/PublicUrlRegistryPageTest.php, src/Listeners/Sitemap/RegenerateSitemapsOnPageSaved.php, src/Manifest/SiteDiscoveryFrontendRoutesContribution.php.

Status details:

  • Status: Available
  • Tier: free
  • 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: URL and discovery-output contracts let packages contribute public records while shared Actions handle deduplication, indexability, sitemap quality, and change notifications.

For teams: Teams can see whether published pages are being offered to crawlers and correct missing or hidden URLs before discovery suffers.

Evidence: src/Contracts/PublicUrlContributor.php, src/Contracts/DiscoveryOutputSource.php, src/Actions/ValidateSitemapQualityAction.php, tests/Integration/Discovery/PublicUrlRegistryActionTest.php, docs/overview.admin.md, src/Actions/BuildGeneratedOutputParityReportAction.php, tests/Integration/Sitemap/SitemapQualityGateTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Page resource sitemap action

Site resource sitemap action

  • Page resource sitemap action (admin, required evidence).
  • Site resource sitemap action (admin, required evidence).
  • Sitemap generation tool (admin, required evidence).
  • Public HTML sitemap page (frontend, required evidence).
  • Generated XML sitemap output (frontend, required evidence).
  • Public URL Registry parity page (admin, required evidence).
  • Public URL Registry quality report (admin, required evidence).
  • Page resource sitemap action with admin sidebar menu open (admin, supplementary evidence).

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.
  • Extension contracts: DiscoverableUrlSource, DiscoveryOutputSource, GeneratedOutputCoverageSource, PublicUrlContributor, Sitemapable, UrlChangeNotifier.
  • Listeners: EnsureSitemapPagesAfterCapellInstalled, RegenerateSitemapsOnPageDeleted, RegenerateSitemapsOnPageSaved, RegenerateSitemapsOnSiteCreated.
  • Actions: BuildGeneratedOutputParityReportAction, BuildPublicSitemapTreeAction, BuildPublicUrlRegistryAction, BuildSitemapXmlResponseAction, DiscoverPublicDiscoveryOutputsAction, DiscoverPublicPagesAction, DiscoverPublicUrlsAction, EnsureSitemapPagesAction, GenerateSitemapAction, GenerateSitemapIncrementallyAction, NotifyPageUrlChangesAction, NotifyPublicUrlChangesAction, and 6 more.
  • Data objects: DiscoverablePageData, DiscoverableUrlData, DiscoveryOutputData, GeneratedOutputParityReportData, GeneratedOutputParityRowData, PublicUrlData, PublicUrlRegistryEntryData, SiteMapData, SitemapAlternateData, SitemapImageData, SitemapNewsData, SitemapPageData, and 7 more.
  • Jobs: RebuildAllSitemapsJob, RebuildSiteSitemapJob, RegenerateSiteSitemapIncrementallyJob.
  • Command signatures: capell:xml-sitemap.
  • Manifest action API: buildGeneratedOutputParityReport: Capell\SiteDiscovery\Actions\BuildGeneratedOutputParityReportAction, buildPublicUrlRegistry: Capell\SiteDiscovery\Actions\BuildPublicUrlRegistryAction, generateSitemap: Capell\SiteDiscovery\Actions\GenerateSitemapAction, setup: Capell\SiteDiscovery\Actions\SetupSiteDiscoveryPackageAction, validateSitemapQuality: Capell\SiteDiscovery\Actions\ValidateSitemapQualityAction.
  • Scheduled commands: capell:xml-sitemap --incremental (manifest declared).
  • 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 extends Capell through admin-page contributions, route contributions, and scheduled-job contributions instead of declaring package-owned tables.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/discovery-foundation, capell-app/frontend.
  • Admin navigation: declares admin-page: PublicUrlRegistryPageContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: none declared.
  • Permissions: View:PublicUrlRegistryPage.
  • Public routes: loads routes/web.php; registers SiteDiscoveryFrontendRoutesContribution.
  • Database changes: no package migrations declared.
  • Config: config/capell-site-discovery.php.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:xml-sitemap --incremental (manifest declared); queue jobs RebuildAllSitemapsJob, RebuildSiteSitemapJob, RegenerateSiteSitemapIncrementallyJob.
  • Cache tags: site-discovery.
  • Commands: capell:xml-sitemap.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/discovery-foundation, capell-app/frontend.
  • Review package configuration before production-like verification: config/capell-site-discovery.php.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Keep the host Laravel scheduler running so package-registered schedules can execute: capell:xml-sitemap --incremental (manifest declared).
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for site-discovery cache tags.

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 declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host 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”
  1. Install the package: composer require capell-app/site-discovery.
  2. Review config/capell-site-discovery.php before enabling the package.
  3. Open the package admin surface at /screenshot-fixtures/site-discovery/page-sitemap-action and confirm Site Discovery is available.

Next Steps

Section titled “Next Steps”