Wiki Bundle Laravel Package

Product Decisions This Supports

• Internal Documentation & Knowledge Base: Enable self-service documentation for engineering teams, reducing reliance on external tools (e.g., Confluence, Notion) and improving version control via Git integration.
• Developer Portal: Build a lightweight, customizable wiki for API documentation, SDK guides, or internal developer resources without heavyweight CMS overhead.
• Roadmap Acceleration: Avoid reinventing a wiki wheel—leverage this bundle to ship a Git-backed wiki faster than building from scratch, especially if Git is already a core part of your workflow.
• Build vs. Buy: Justify a "build" decision by repurposing an open-source, Git-native solution instead of licensing a proprietary wiki tool (cost savings + alignment with existing Git workflows).
• Use Cases:
  • Internal team wikis (e.g., "How to Deploy," "Troubleshooting").
  • Public-facing developer docs (if combined with Symfony’s security layers).
  • Git-aware documentation where changes should mirror code commits (e.g., README.md-style docs in a repo).

When to Consider This Package

• Adopt if:

  • Your team already uses Git for version control and wants documentation to live alongside code.
  • You need a lightweight, Symfony-native solution (no heavy CMS like MediaWiki or DokuWiki).
  • Your wiki content is markdown-based or can be converted to markdown.
  • You prioritize simplicity over advanced features (e.g., no need for user comments, complex permissions, or WYSIWYG editors).
  • Your stack is PHP/Symfony, and you want to avoid polyglot persistence (e.g., mixing PHP with Node.js/React for docs).

• Look elsewhere if:

  • You need collaborative editing (real-time co-authoring) → Consider Etherpad or HackMD.
  • Your audience requires rich media (videos, complex diagrams) → Evaluate Confluence, Notion, or GitBook.
  • You lack Symfony expertise to customize/extend the bundle.
  • Your team needs fine-grained access control (e.g., per-page permissions) → Proprietary tools like Document360 may fit better.
  • You want SEO-friendly public docs → Static site generators (e.g., Docusaurus, MkDocs) may be more maintainable.

How to Pitch It (Stakeholders)

For Executives: "This Git-backed wiki bundle lets us replace fragmented docs (Slack, emails, stale READMEs) with a single, version-controlled source of truth—all while keeping costs near zero. By tying documentation to Git commits, we ensure docs stay in sync with code changes, reducing onboarding time and tech debt. It’s a lightweight alternative to expensive CMS tools, with the added benefit of leveraging our existing Symfony stack. Pilot it for internal engineering docs first; if successful, we can expand to customer-facing resources."

For Engineering: *"This Symfony bundle gives us a Git-native wiki with minimal setup:

• Pros:
  • Docs live in Git (familiar workflow, PR reviews, history).
  • No external dependencies—just markdown + Symfony.
  • Easy to customize (e.g., add search, themes, or API access).
• Cons:
  • Basic UI (but we can style it or pair with a frontend framework).
  • No built-in user management (but we can integrate Symfony’s security). Use case: Replace our ad-hoc docs/ folder with a proper wiki that engineers can edit like code. Let’s prototype it for the [Project X] docs repo first."*

For Developers: *"This is a Symfony bundle that turns a Git repo into a wiki. Key features:

• Markdown-based pages (edit like README.md).
• Git integration (pages are files; edits trigger commits).
• Symfony-friendly (easy to extend with custom routes, controllers, or Twig templates). How to start:

1. Install via Composer: composer require chitanka/wiki-bundle.
2. Configure routes and Git repo path in config/packages/wiki.yaml.
3. Create a markdown file in the repo (e.g., GettingStarted.md).
4. Access it at /wiki/GettingStarted. Next steps: Add a search bar or integrate with our existing auth system."*