Weave Code
Documentation Search Laravel Package
stillat/documentation-search
A Laravel/PHP package from Stillat for adding searchable documentation to your application, helping you index docs and surface relevant results through a simple search experience.
At a glance
Frequently asked questions about Documentation Search
- What is stillat/documentation-search used for?
- stillat/documentation-search is a Laravel/PHP package from Stillat for adding searchable documentation to your application. It is intended to help you index documentation content and surface relevant results through a simple search experience. The supplied assessment notes a likely fit with Laravel service-provider patterns and the Statamic addon ecosystem.
- How do I install stillat/documentation-search?
- Install it with Composer, for example composer require stillat/documentation-search, then wire up the package's service provider and configuration as documented upstream. Because v2.0.0 is a major release with a provider contract change, pin the version you have tested and review the changelog before installing. Confirm PHP, Laravel, and Statamic requirements in the package's composer.json first.
- Does stillat/documentation-search support Statamic 6?
- Yes, the v2.0.0 release notes indicate Statamic 6 support, which the provisional assessment treats as a positive platform-alignment signal. That same alignment likely narrows the compatible platform set, so validate your exact Statamic 6 version and related addons. Statamic 6 support is not the same as confirmed support for older Statamic versions.
- What changed in stillat/documentation-search v2.0.0?
- The headline change in v2.0.0 is that providers return references instead of objects. That is a contract-level change affecting consuming code that relies on object identity, type hints, container bindings, facades, or direct provider return values. The release notes alone do not document the full public API diff or an upgrade guide.
- Is v2.0.0 a drop-in upgrade from v1?
- No. Treat v2.0.0 as a major-version platform-alignment release, not a routine dependency bump. Object-to-reference changes can produce type errors and lifecycle differences, so plan a controlled rollout. Pin v1 in production while you test v2 in an upgrade branch.
- How should I migrate from documentation-search v1 to v2?
- Inventory every usage of the package's provider and public APIs, then create an upgrade branch and apply the ^2.0 constraint. Update Statamic to 6 where required, adapt consumers to reference-based returns, and run static analysis plus application-level regression tests. Stage and canary the change with a documented rollback to v1.
- What are the references returned by providers in documentation-search v2?
- The release notes say providers now return references instead of objects, but the supplied assessment does not confirm whether those are Laravel container references, Statamic references, PHP references, or another abstraction. Treat the semantics as an open question until the package documents them. Confirm this before refactoring any provider consumer.
- Does stillat/documentation-search work in a plain Laravel app without Statamic?
- The package is described as a Laravel/PHP package, and the assessment notes a likely fit with Statamic addon ecosystems. Whether it requires Statamic at runtime is not confirmed by the release-notes-only context. Check its composer.json dependencies before assuming it works in a plain Laravel application.
- Does v2.0.0 still support Statamic 5 and older Laravel versions?
- Likely not, or at least not without a maintained v1 branch. v2.0.0 aligns with Statamic 6 and the assessment warns that this narrows the compatible platform set. Applications still on Statamic 5 should stay on a supported v1 release unless upstream explicitly confirms otherwise.
- Is stillat/documentation-search production-ready, and what should I test before adopting v2?
- Before production, test provider resolution, object-identity assumptions, serialization, caching, queue workers, and long-running processes under Statamic 6. Monitor provider-resolution errors and deployment health during canary, and keep a rollback path. Support quality and maintenance activity are not established by release notes alone, so review the repository's issues, releases, and license before committing.
Weaver
How can I help you explore Laravel packages today?