- How do I install finity-labs/lin-codex in a Laravel app?
- Install it with Composer by requiring finity-labs/lin-codex. Laravel package discovery should register the service provider automatically; if your app disables discovery, register it as described in the README. Then follow the package setup steps for publishing configuration and assets, and run migrations if you plan to store help articles in the database.
- Should I store Lin Codex help articles as Markdown files or in the database?
- Lin Codex supports both Markdown files and database-backed articles, so the choice depends on your workflow. Markdown is a good fit when help content should live in version control and be reviewed with code changes. Database storage is more suitable when non-developers need to edit articles at runtime or when content changes frequently.
- How does contextual help work in Lin Codex?
- Lin Codex is designed to show help articles that match the part of the application a user is currently viewing. You define help content and associate it with the relevant pages or features, then present it through the package's help UI. The Livewire help drawer gives users a place to read that contextual guidance without leaving the app.
- Does Lin Codex include search for help articles?
- Yes, Lin Codex includes search across your help articles. This helps users find relevant guidance when they do not already know which contextual article to open. Search works with the help content you provide, whether it comes from Markdown files or the database.
- Can I provide translated help articles with Lin Codex?
- Yes, Lin Codex supports translations for help content. You can provide localized article content and let Laravel's localization settings determine which version users see. This is useful for applications with multilingual users who need in-app help in their own language.
- How do I add the Livewire help drawer to my Laravel layout?
- Lin Codex provides a Livewire help drawer component that you include in your application's layout or navigation. Add the component where you want the help entry point to appear, following the exact component name and usage in the README. Because it is Livewire-based, users can open and browse help without a full page reload.
- Which Laravel versions are supported by finity-labs/lin-codex?
- The package is built for Laravel, but the exact supported Laravel and PHP version constraints should be checked in its composer.json and README. Those files are the source of truth because support can change between releases. Also confirm the Livewire version required by the help drawer before installing.
- Is Lin Codex suitable for production Laravel applications?
- Yes, Lin Codex is intended for in-app help in Laravel applications, including production use. Before deploying, review how your articles are stored, run any required database migrations, and confirm translations and search behave correctly with your content. If articles are database-backed, plan for backups and access control around content editing.
- How can I test Lin Codex help articles and search in Laravel?
- Use Laravel's testing tools to create or seed help articles, then assert that contextual lookups and search return the expected results. You can also test that the Livewire help drawer renders and opens correctly in your layout. Keep fixtures for Markdown and database content if you use both sources.
- What are alternatives to Lin Codex for Laravel in-app help?
- Alternatives include external documentation sites, static help pages built with Blade, or custom in-app support widgets. Lin Codex is focused on contextual help inside Laravel with Markdown or database articles, search, translations, and a Livewire drawer. Choose it when you want help content managed close to the application rather than in a separate docs platform.