- What is qossmic/twig-doc-bundle used for?
- qossmic/twig-doc-bundle is a Symfony bundle that scans Twig templates for annotated documentation comments and generates browsable HTML docs. It helps teams keep template variables, blocks, and includes discoverable instead of relying on tribal knowledge. The package is aimed at Twig UX component documentation, not at runtime application features.
- Is qossmic/twig-doc-bundle compatible with Laravel?
- qossmic/twig-doc-bundle is a Symfony bundle for Twig and Twig UX components, not a native Laravel package. Laravel uses Blade by default, so using this package would require a Twig bridge and manual bundle or service registration. Treat Laravel adoption as a custom adaptation and validate the repository before committing.
- How do I install qossmic/twig-doc-bundle?
- Install it as a development dependency with composer require --dev qossmic/twig-doc-bundle. In a Symfony app you then enable the bundle and publish or edit its configuration. Because it is documentation tooling, keep it out of production runtime dependencies where possible.
- What version of qossmic/twig-doc-bundle should I pin?
- The package is pre-1.0 at v0.0.3, so Composer's caret constraint will not carry you across minor bumps. Pin an explicit version in require-dev and check the PHP and Symfony version constraints before upgrading. This is especially important for CI reproducibility and onboarding.
- How does qossmic/twig-doc-bundle extract documentation?
- It scans your Twig templates and reads annotated documentation comments embedded in them. It then generates browsable HTML documentation covering variables, blocks, and includes. The output is meant to make component contracts discoverable for developers and designers.
- Does qossmic/twig-doc-bundle run in production?
- It is documentation and dev-tooling, so it belongs in require-dev and CI or local workflows, not the customer-facing runtime path. That bounds adoption risk to build and developer environments. If accidentally required in production, it should not be on a hot request path, but avoid that setup.
- How do I configure qossmic/twig-doc-bundle?
- Configuration is file-driven: you publish the bundle config and point it at the Twig template directories you want scanned. Keep the config in version control so generated docs are reproducible. Confirm the exact keys against the repository README for your pinned version.
- How do I test generated Twig documentation in CI?
- Add a CI step that runs the bundle's documentation generation command against a fixture template set and asserts the expected HTML output. Because the package is pre-1.0, pin the version and snapshot key output. This catches template annotation drift before docs go stale.
- What are alternatives to qossmic/twig-doc-bundle?
- For Twig and Symfony teams, Storybook for Twig UX components or custom Twig comment parsers are common alternatives. For Laravel teams, Blade component documentation and native Laravel testing helpers may cover the need without adding a Symfony dependency. Compare overlap with your existing docs tooling before adopting.
- Is qossmic/twig-doc-bundle actively maintained?
- The context shows a v0.0.3 pre-1.0 release, which signals early-stage maintenance rather than a mature 1.0 line. Check the repository commit cadence, maintainer count, test coverage, and license before adopting. A 1.0 roadmap should be confirmed if long-term support matters.