Static Site Bundle Laravel Package

Product Decisions This Supports

• Static Site Generation (SSG) for Documentation:
  • Enable self-hosted, GitHub Pages-compatible documentation for Symfony2 projects (e.g., BraincraftedBootstrapBundle).
  • Reduce server costs by eliminating the need for a live Symfony2 environment for static content.
• Decoupling Content from Backend:
  • Generate static HTML from Symfony2 controllers, allowing teams to maintain documentation in the same codebase as the product.
• Multi-Format Output:
  • Support for JSON, CSV, YAML, and front-matter generators to serve structured data or API docs alongside static pages.
• Build vs. Buy:
  • Buy: Avoid reinventing SSG for Symfony2 (e.g., custom Twig templates + symfony/process).
  • Build: Only if needing advanced dynamic content generation (e.g., real-time data injection).
• Roadmap for Legacy Systems:
  • Modernize older Symfony2 projects by migrating static assets to GitHub Pages or Netlify without rewriting the entire app.
• Use Cases:
  • Developer portals, API documentation, changelogs, or marketing sites built on Symfony2.
  • Teams using Symfony2 but wanting to leverage static hosting for performance/cost savings.

When to Consider This Package

• Adopt if:
  • You’re using Symfony2 and need to generate static HTML from controllers (e.g., docs, marketing sites).
  • Your team prefers keeping content in the Symfony2 codebase but wants to host it statically (GitHub Pages, Netlify).
  • You require multi-format output (JSON/CSV/YAML) alongside HTML for APIs or data exports.
  • You’re migrating away from live Symfony2 hosting for static content to reduce costs.
• Look Elsewhere if:
  • You’re using Symfony 3+ or 5/6/7: This bundle is Symfony2-only; consider symfony/ux-turbo or jigsaw for modern stacks.
  • You need JAMstack features (e.g., Markdown/MDX, GraphQL): Use netlifycms or eleventy.
  • You require dynamic content at build time: This is static-only; pair with a headless CMS or API.
  • Your project is PHP 8.1+: This bundle may not support newer PHP versions.
  • You need advanced theming: Consider twiglite or pelican for more flexible templating.

How to Pitch It (Stakeholders)

For Executives: "This package lets us generate static HTML documentation or marketing sites directly from our Symfony2 codebase—eliminating the need for a live server and cutting hosting costs. For example, we could move our BraincraftedBootstrapBundle docs to GitHub Pages, reducing infrastructure spend while keeping content version-controlled. It’s a lightweight, Symfony-native solution for teams already using the framework."

For Engineering: *"CocurBuildBundle is a minimal Symfony2 bundle that compiles controllers into static HTML, JSON, CSV, etc., at build time. It’s ideal if:

• You want to host docs on GitHub Pages/Netlify without a live Symfony2 environment.
• You need structured data exports (e.g., API specs in YAML/JSON) alongside HTML.
• You’re phasing out Symfony2 but still need to generate static assets from existing controllers.

Trade-offs:

• Symfony2-only: Not compatible with newer Symfony versions.
• Early-stage: Limited community support (only 4 stars, but MIT-licensed).
• No dynamic builds: Content is pre-generated; use a CMS or API for real-time updates.

Alternatives: If you’re open to modernizing, consider jigsaw (Laravel-based) or eleventy (Node.js). But for Symfony2, this is the simplest path to static sites."*