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/theme-knowledge |
| Package slug | theme-knowledge |
| Product group | Capell Themes |
| Tier | premium |
| Bundle | themes |
| Runtime contexts | frontend |
| Capell version | ^1.0 |
| Source repository | capell-app/packages |
| Source path | packages/theme-knowledge |
| Docs source | packages/theme-knowledge/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Knowledge Base is an Available, No schema impact Capell theme in the Capell Themes product group. It ships as capell-app/theme-knowledge and extends these surfaces: frontend.
Theme Knowledge adds search, document-tree, API-reference, callout, changelog, and feedback presentation for documentation sites. Knowledge content remains owned by Capell or the configured integration.
Editors arrange documentation pages through Layout Builder, while visitors receive search-first navigation, structured reference content, and a feedback surface.
Evidence: src/KnowledgeThemeServiceProvider.php, resources/views/widget/search-spotlight-hero.blade.php, resources/views/widget/doc-tree-sidebar.blade.php, resources/views/widget/api-reference-parameter-table.blade.php, resources/views/widget/feedback-footer.blade.php, tests/Feature/KnowledgeBespokeWidgetsTest.php.
Status details:
- Status: Available
- Tier: premium
- Bundle: themes
- Composer package:
capell-app/theme-knowledge - Namespace:
Capell\ThemeKnowledge - Theme key:
knowledge
Why It Matters
Section titled “Why It Matters”For developers: The provider registers layout areas and documentation widget keys through the shared rendering pipeline, with a typed boundary for optional knowledge-base integration.
For teams: Documentation teams can combine guides, API details, changes, and reader feedback in one consistent public presentation.
Evidence: src/KnowledgeThemeServiceProvider.php, src/Actions/ResolveKnowledgeBaseIntegrationAction.php, src/Data/KnowledgeBaseIntegrationData.php, resources/views/widget/doc-tree-sidebar.blade.php, resources/views/widget/api-reference-parameter-table.blade.php, resources/views/widget/feedback-footer.blade.php.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
Desktop, tablet, and mobile variants remain defined in the screenshot contract; this list groups them by workflow.
- Knowledge Homepage (frontend, required).
- Knowledge Directory (frontend, required).
- Knowledge Detail (frontend, required).
- Knowledge Contact form (frontend, optional).
- Knowledge Empty state (frontend, optional).
- Knowledge 404 (frontend, optional).
- Knowledge Get started (frontend, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\ThemeKnowledge\KnowledgeThemeServiceProvider. - Actions:
InstallKnowledgeThemeDemoAction,ResolveKnowledgeBaseIntegrationAction. - Data objects:
KnowledgeBaseIntegrationData. - Command signatures:
capell:theme-knowledge-demo. - Console command classes:
KnowledgeDemoCommand. - Manifest contributions:
admin-page: Capell\ThemeKnowledge\Manifest\ThemeManagementPageContribution. - Health checks:
Capell\ThemeKnowledge\Health\ThemeKnowledgeHealthCheck. - Blade views:
packages/theme-knowledge/resources/views/footer.blade.php,packages/theme-knowledge/resources/views/header/index.blade.php,packages/theme-knowledge/resources/views/widget/api-reference-parameter-table.blade.php,packages/theme-knowledge/resources/views/widget/callout-admonition-system.blade.php,packages/theme-knowledge/resources/views/widget/doc-tree-sidebar.blade.php,packages/theme-knowledge/resources/views/widget/feedback-footer.blade.php,packages/theme-knowledge/resources/views/widget/in-article-toc-scroll-spy.blade.php,packages/theme-knowledge/resources/views/widget/search-spotlight-hero.blade.php,packages/theme-knowledge/resources/views/widget/version-changelog-surfaces.blade.php. - Cache tags:
theme-knowledge.
Data Model
Section titled “Data Model”This theme has no schema impact. It relies on core Capell site, page, locale, and theme records instead of declaring package-owned tables.
Install Impact
Section titled “Install Impact”- Required packages:
capell-app/core,capell-app/theme-foundation,capell-app/frontend,capell-app/layout-builder. - Admin navigation: declares
admin-page: ThemeManagementPageContribution; each Filament page or resource controls its own navigation visibility. - Admin/editor extensions: none declared.
- Permissions: none declared in
capell.json. - Public routes: none declared.
- Database changes: no package migrations declared.
- Config: no package config files.
- Settings: no package settings declared.
- Queues or schedules: none declared.
- Cache tags:
theme-knowledge. - Commands:
capell:theme-knowledge-demo.
Common Pitfalls
Section titled “Common Pitfalls”- Keep required Capell packages on compatible v4 releases:
capell-app/core,capell-app/theme-foundation,capell-app/frontend,capell-app/layout-builder. - 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
theme-knowledgecache 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 |
| 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/theme-knowledge. - No package-specific setup command or migrations are declared.
- Open the Knowledge Homepage and confirm the public output renders without admin state.
Next Steps
Section titled “Next Steps”- Package docs
- Overview
- Troubleshooting
- Screenshot contract
- Marketplace assets
- Capell content language plan
- Capell documentation design system
- Capell and package ERD notes
- Related packages: Theme Foundation, Layout Builder.
- Focused tests:
vendor/bin/pest packages/theme-knowledge/tests --configuration=phpunit.xml.