Skip to content
Capell CMS

Knowledge Base

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/knowledge-base
Package slug knowledge-base
Product group Capell Engagement & CRM
Tier premium
Bundle engagement-crm
Runtime contexts frontend, admin
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/knowledge-base
Docs source packages/knowledge-base/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Knowledge Base is an Available, Schema-owning Capell package in the Capell Engagement & CRM product group. It ships as capell-app/knowledge-base and extends these surfaces: frontend, admin.

Knowledge Base adds help collections, versioned articles, related content, reader feedback, and public documentation routes.

Editors manage collections and articles in admin, while visitors browse and search published help content under the public knowledge-base path.

Evidence: src/Actions/CreateKnowledgeBaseCollectionAction.php, src/Actions/CreateKnowledgeBaseArticleAction.php, src/Actions/PublishKnowledgeBaseArticleVersionAction.php, routes/web.php, tests/Feature/Filament/KnowledgeBaseAdminSurfaceTest.php, src/Actions/BuildPublicKnowledgeBaseNavigationAction.php, tests/Feature/Frontend/KnowledgeBasePublicRoutesTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: engagement-crm
  • Composer package: capell-app/knowledge-base
  • Namespace: Capell\KnowledgeBase
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Actions build sanitized public article data, navigation, search documents, and AI-readable output from the same article records.

For teams: Support teams can publish and revise a self-service help centre, then use article feedback to identify content that needs attention.

Evidence: src/Actions/BuildPublicKnowledgeBaseArticleDataAction.php, src/Actions/BuildKnowledgeBaseSearchDocumentsAction.php, src/Actions/BuildAiReadableKnowledgeBaseOutputAction.php, tests/Feature/Frontend/KnowledgeBaseArticleHtmlSanitizationTest.php, docs/overview.admin.md, src/Actions/RecordKnowledgeBaseArticleFeedbackAction.php, src/Actions/BuildKnowledgeBaseArticleFeedbackSummaryAction.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Knowledge Base articles admin index

Knowledge Base article edit and version history

  • Knowledge Base articles admin index (admin, required).
  • Knowledge Base article edit and version history (admin, required).
  • Knowledge Base public docs index (frontend, required).
  • Knowledge Base public article (frontend, required).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\KnowledgeBase\Providers\KnowledgeBaseServiceProvider, Capell\KnowledgeBase\Providers\AdminServiceProvider.
  • Config files: packages/knowledge-base/config/capell-knowledge-base.php.
  • Migrations: packages/knowledge-base/database/migrations/2026_05_31_000001_create_knowledge_base_tables.php, packages/knowledge-base/database/migrations/2026_07_10_000001_add_feedback_deduplication_key.php.
  • Models: KnowledgeBaseArticle, KnowledgeBaseArticleFeedback, KnowledgeBaseArticleVersion, KnowledgeBaseCollection, KnowledgeBaseRelatedArticle.
  • Filament classes: KnowledgeBaseArticleResource, CreateKnowledgeBaseArticle, EditKnowledgeBaseArticle, ListKnowledgeBaseArticles, ArticleVersionsRelationManager, RelatedArticlesRelationManager, KnowledgeBaseCollectionResource, CreateKnowledgeBaseCollection, EditKnowledgeBaseCollection, ListKnowledgeBaseCollections.
  • Route files: packages/knowledge-base/routes/web.php.
  • Policies: AbstractKnowledgeBaseResourcePolicy, KnowledgeBaseArticlePolicy, KnowledgeBaseCollectionPolicy.
  • Actions: BuildAiReadableKnowledgeBaseOutputAction, BuildKnowledgeBaseArticleFeedbackSummaryAction, BuildKnowledgeBaseArticleSchemaAction, BuildKnowledgeBaseSearchDocumentsAction, BuildPublicKnowledgeBaseArticleDataAction, BuildPublicKnowledgeBaseNavigationAction, CreateKnowledgeBaseArticleAction, CreateKnowledgeBaseArticleVersionAction, CreateKnowledgeBaseCollectionAction, FindPublicKnowledgeBaseArticleAction, ForgetKnowledgeBaseArticleFeedbackSummaryAction, PruneKnowledgeBaseHistoryAction, and 6 more.
  • Data objects: AiReadableKnowledgeBaseArticleData, CreateKnowledgeBaseArticleData, CreateKnowledgeBaseArticleVersionData, CreateKnowledgeBaseCollectionData, KnowledgeBaseArticleFeedbackSummaryData, KnowledgeBaseSearchDocumentData, PublicKnowledgeBaseArticleData, PublicKnowledgeBaseNavigationItemData, RecordKnowledgeBaseArticleFeedbackData, UpdateKnowledgeBaseArticleData, UpdateKnowledgeBaseCollectionData.
  • Command signatures: capell:knowledge-base-demo, capell:knowledge-base:prune.
  • Manifest action API: buildAiReadableKnowledgeBaseOutput: Capell\KnowledgeBase\Actions\BuildAiReadableKnowledgeBaseOutputAction, buildKnowledgeBaseArticleSchema: Capell\KnowledgeBase\Actions\BuildKnowledgeBaseArticleSchemaAction, buildKnowledgeBaseSearchDocuments: Capell\KnowledgeBase\Actions\BuildKnowledgeBaseSearchDocumentsAction, buildPublicKnowledgeBaseArticleData: Capell\KnowledgeBase\Actions\BuildPublicKnowledgeBaseArticleDataAction, buildPublicKnowledgeBaseNavigation: Capell\KnowledgeBase\Actions\BuildPublicKnowledgeBaseNavigationAction, createKnowledgeBaseArticle: Capell\KnowledgeBase\Actions\CreateKnowledgeBaseArticleAction, createKnowledgeBaseArticleVersion: Capell\KnowledgeBase\Actions\CreateKnowledgeBaseArticleVersionAction, pruneKnowledgeBaseHistory: Capell\KnowledgeBase\Actions\PruneKnowledgeBaseHistoryAction, publishKnowledgeBaseArticleVersion: Capell\KnowledgeBase\Actions\PublishKnowledgeBaseArticleVersionAction, recordKnowledgeBaseArticleFeedback: Capell\KnowledgeBase\Actions\RecordKnowledgeBaseArticleFeedbackAction, relateKnowledgeBaseArticles: Capell\KnowledgeBase\Actions\RelateKnowledgeBaseArticlesAction.
  • Scheduled commands: capell:knowledge-base:prune (daily).
  • Console command classes: DemoCommand, PruneKnowledgeBaseHistoryCommand.
  • Manifest contributions: admin-resource: Capell\KnowledgeBase\Manifest\KnowledgeBaseArticleResourceContribution, admin-resource: Capell\KnowledgeBase\Manifest\KnowledgeBaseCollectionResourceContribution, model: Capell\KnowledgeBase\Manifest\KnowledgeBaseModelsContribution, route: Capell\KnowledgeBase\Manifest\KnowledgeBaseFrontendRoutesContribution, scheduled-job: Capell\KnowledgeBase\Manifest\KnowledgeBaseRetentionScheduleContribution.
  • Health checks: Capell\KnowledgeBase\Health\KnowledgeBaseHealthCheck.
  • Blade views: packages/knowledge-base/resources/views/article.blade.php, packages/knowledge-base/resources/views/index.blade.php, packages/knowledge-base/resources/views/partials/collection-navigation.blade.php.
  • Cache tags: knowledge-base.

Data Model

Section titled “Data Model”
  • Required tables: knowledge_base_collections, knowledge_base_articles, knowledge_base_article_versions, knowledge_base_article_feedback, knowledge_base_related_articles.
  • Models: KnowledgeBaseArticle, KnowledgeBaseArticleFeedback, KnowledgeBaseArticleVersion, KnowledgeBaseCollection, KnowledgeBaseRelatedArticle.
  • Migration files: 2026_05_31_000001_create_knowledge_base_tables.php, 2026_07_10_000001_add_feedback_deduplication_key.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; retention is scheduled through capell:knowledge-base:prune (daily).

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend.
  • Admin navigation: declares admin-resource: KnowledgeBaseArticleResourceContribution, admin-resource: KnowledgeBaseCollectionResourceContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: none declared.
  • Permissions: none declared in capell.json.
  • Public routes: loads routes/web.php; registers KnowledgeBaseFrontendRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/capell-knowledge-base.php.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:knowledge-base:prune (daily).
  • Cache tags: knowledge-base.
  • Commands: capell:knowledge-base-demo, capell:knowledge-base:prune.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-knowledge-base.php.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Register the host scheduler so these declared commands run at their documented frequencies: capell:knowledge-base:prune (daily).
  • 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 knowledge-base 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
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
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/knowledge-base.
  2. Run the required setup: php artisan migrate.
  3. Open the Knowledge Base articles admin index and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”