Knowledge Base

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	Beta
Source repository	capell-app/packages
Source path	packages/knowledge-base
Docs source	packages/knowledge-base/docs
Manifest	capell.json

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.

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

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.

Screens And Workflow

Screenshot contract: docs/screenshots.json.

• Knowledge Base articles admin index (admin, required evidence).
• Knowledge Base article edit and version history (admin, required evidence).
• Knowledge Base public docs index (frontend, required evidence).
• Knowledge Base public article (frontend, required evidence).
• Knowledge Base articles admin index with admin sidebar menu open (admin, supplementary evidence).

Technical Shape

Service providers

• Capell\KnowledgeBase\Providers\KnowledgeBaseServiceProvider
• Capell\KnowledgeBase\Providers\ConsoleServiceProvider
• 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
• packages/knowledge-base/database/migrations/2026_10_04_000001_remove_implicit_timestamp_updates_from_knowledge_base.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
• BuildKnowledgeBaseFrontendResourcesAction
• BuildKnowledgeBaseSearchDocumentsAction
• BuildPublicKnowledgeBaseArticleDataAction
• BuildPublicKnowledgeBaseNavigationAction
• CreateKnowledgeBaseArticleAction
• CreateKnowledgeBaseArticleVersionAction
• CreateKnowledgeBaseCollectionAction
• FindPublicKnowledgeBaseArticleAction
• ForgetKnowledgeBaseArticleFeedbackSummaryAction
• PruneKnowledgeBaseHistoryAction
• PublishKnowledgeBaseArticleVersionAction
• RecordKnowledgeBaseArticleFeedbackAction
• RelateKnowledgeBaseArticlesAction
• SanitizeKnowledgeBaseArticleHtmlAction
• SeedKnowledgeBaseDemoAction
• SeedKnowledgeBaseScreenshotFixtureAction
• UpdateKnowledgeBaseArticleAction
• UpdateKnowledgeBaseCollectionAction

Data objects

• AiReadableKnowledgeBaseArticleData
• CreateKnowledgeBaseArticleData
• CreateKnowledgeBaseArticleVersionData
• CreateKnowledgeBaseCollectionData
• KnowledgeBaseArticleFeedbackSummaryData
• KnowledgeBaseSearchDocumentData
• PublicKnowledgeBaseArticleData
• PublicKnowledgeBaseNavigationItemData
• RecordKnowledgeBaseArticleFeedbackData
• SeedKnowledgeBaseDemoData
• 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
• seedKnowledgeBaseDemo: Capell\KnowledgeBase\Actions\SeedKnowledgeBaseDemoAction

Scheduled commands

• capell:knowledge-base:prune (daily; manifest declared)

Console command classes

• DemoCommand
• PruneKnowledgeBaseHistoryCommand
• SeedKnowledgeBaseScreenshotFixtureCommand

Manifest contributions

• admin-resource: Capell\KnowledgeBase\Manifest\KnowledgeBaseArticleResourceContribution
• admin-resource: Capell\KnowledgeBase\Manifest\KnowledgeBaseCollectionResourceContribution
• migration: Capell\KnowledgeBase\Manifest\KnowledgeBaseMigrationsContribution
• 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

• 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, 2026_10_04_000001_remove_implicit_timestamp_updates_from_knowledge_base.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; declared in the manifest).

Install Impact

• Required packages: capell-app/admin, capell-app/core, capell-app/discovery-foundation, 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: access also governed by package policies: AbstractKnowledgeBaseResourcePolicy, KnowledgeBaseArticlePolicy, KnowledgeBaseCollectionPolicy.
• 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; manifest declared).
• Cache tags: knowledge-base.
• Commands: capell:knowledge-base-demo, capell:knowledge-base:prune.

Common Pitfalls

• Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/discovery-foundation, 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.
• Keep the host Laravel scheduler running so package-registered schedules can execute: capell:knowledge-base:prune (daily; 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 knowledge-base cache tags.

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

1. Install the package: composer require capell-app/knowledge-base.
2. See it working: run php artisan capell:knowledge-base-demo.
3. Open the package admin surface at /admin/knowledge-base/articles/knowledge-base-articles and confirm Knowledge Base is available.

Next Steps

• Package docs
• Overview
• Worked extension examples
• Admin guide
• Configuration files: config/capell-knowledge-base.php.
• Troubleshooting
• Screenshot contract
• Marketplace assets
• Capell content language plan
• Capell documentation design system
• Capell and package ERD notes
• Related packages: Discovery Foundation, Search, Seo Suite, Site Discovery.