Weave Code
Weaver
Helps Laravel developers discover, compare, and choose open-source packages. See popularity, security, maintainers, and scores at a glance to make better decisions.
Feedback
Share your thoughts, report bugs, or suggest improvements.
Subject
Message

Laradocs Laravel Package

petebishwhip/laradocs

Laradocs is a Laravel package for adding documentation to your app. Write docs in Markdown, organize pages into sections, and render a clean, customizable documentation site with navigation and search inside your existing Laravel project.

View on GitHub
Deep Wiki
Context7

Technical Evaluation

Architecture fit. Laradocs is a self-hosted documentation package for Laravel: markdown content served through Laravel routes with an Inertia-based UI, plus an MCP surface so AI agents/tooling can query the docs corpus. For a Laravel shop this is a low-friction fit — it lives in the same app, same auth, same deploy pipeline, no separate docs site or static-site generator to maintain. The relevant question is scope: it is a docs viewer, not a docs platform. If we need versioned docs, search at scale, or multi-product navigation, validate that before committing.

Integration feasibility. Standard Composer package with Laravel auto-discovery; expected flow is composer require, publish config/views/assets, drop markdown into a content directory, and expose routes under a configurable prefix. The two changes in v1.2.1 are narrow: a documentation credit for inertiaui.com and — the material one — support for laravel/mcp v1.0. The latter is a compatibility expansion, not a behavior change, but it does move the package's dependency floor onto the first stable major of Laravel's MCP server. That is the only line item with integration consequences, and it is a loosening of constraints if we were previously held back at laravel/mcp 0.x.

Technical risk.

  • Bus factor. Single-maintainer package (PeteBishwhip). Low velocity is fine for a docs viewer; it is not fine if we make it the only path to internal documentation. Treat as replaceable-by-design.
  • UI dependency coupling. The Inertia UI mention suggests the front-end leans on inertiaui.com components. Confirm which components and whether any are licensed/pro-tier — a paid dependency inside a "free" docs package is a budget and procurement surprise, not a technical one.
  • MCP surface maturity. laravel/mcp v1.0 is new. Supporting it is a positive signal (maintainer is tracking the ecosystem), but the protocol and its Laravel binding are still settling. Anything we build on the MCP endpoint should be treated as experimental.
  • Exposure risk. A docs package that registers routes and an MCP tool endpoint can leak internal runbooks, ADRs, or credentials-adjacent notes if the prefix is public by default. This is the highest-severity failure mode and it is a configuration problem, not a code problem.

Key questions.

  1. What are the supported Laravel/PHP version ranges, and does v1.2.1 change the Composer floor for laravel/mcp in a way that conflicts with our pinned version?
  2. Is the MCP endpoint opt-in or on-by-default, and what authorization hook does it expose?
  3. Which Inertia UI components are used, and are any of them commercially licensed?
  4. Does the package support static export / full-page caching, or is every request a Laravel render?
  5. What is the documented upgrade path for published assets between minor versions?

Integration Approach

Stack fit. Assumes Laravel 10/11/12 on PHP 8.2+. No new infrastructure: no Node build beyond the package's published assets, no search service, no DB migrations expected for a markdown-backed viewer (verify). Fits existing auth middleware, existing CI, existing deploy.

Migration path. Nothing to migrate. This is additive: a new route group and a content directory. If we currently keep docs in a wiki or Notion, the migration is a content-and-ownership exercise, not a technical one — and it should not block adoption. Start with a narrow corpus (one team, one service) rather than a wholesale wiki import.

Compatibility. The v1.2.1 change is a dependency-range expansion for laravel/mcp v1.0. Confirm our laravel/mcp constraint before bumping; if we are on 0.x and other packages depend on it, we now have a version-coordination point. Pin laradocs to ^1.2.1 rather than a floating constraint so the MCP floor does not shift under us.

Sequencing.

  1. Resolve the open questions above; confirm licensing and MCP defaults.
  2. Install in a non-production environment behind existing auth; verify route prefix and asset publishing.
  3. Land a small pilot corpus and review output quality and search/navigation behavior.
  4. Gate the MCP endpoint separately — ship it disabled by default, enable for one internal consumer, instrument it.
  5. Only then evaluate broader content migration.

Operational Impact

Maintenance. Near-zero runtime maintenance: static content, no data store of consequence, no background jobs. The recurring cost is content stewardship — docs rot silently, and a docs viewer makes rot visible. Assign an owner per corpus or the package becomes a graveyard.

Support. Small package, small community, one maintainer. Expect to self-support edge cases and to read the source. Acceptable for an internal tool; unacceptable if external customers depend on it.

Scaling. Read-mostly, cacheable, cheap. Render cost scales with page views, not data volume; put a CDN or response cache in front if the docs are public. The MCP endpoint is the unknown — agent-driven query patterns are bursty and less cacheable; watch it separately.

Failure modes.

  • Content exposure — routes or MCP reachable without auth. Mitigate with middleware and a deploy-time smoke test asserting 401/403 on the docs prefix.
  • Upgrade drift — published views/assets diverge from package templates across versions; re-publish deliberately and diff.
  • Dependency collision — laravel/mcp major bumps ripple into laradocs; pin and track.
  • Maintainer abandonment — fork-and-own is the fallback; the markdown corpus survives any replacement tooling, which is the real mitigation.

Ramp-up. A Laravel developer is productive in under a day: install, point at a folder, read the config file. Content authors need a short style/conventions guide more than technical onboarding. Budget a half-day for whoever owns the auth and exposure decision — that is the part that carries risk, and it is not the part the package's docs will teach you.

Verdict on v1.2.1. A low-risk patch: one docs credit, one dependency-compatibility expansion. Adopt it if we are on or moving to laravel/mcp v1.0; otherwise it is a no-op we can take whenever the next bump happens. It does not change the strategic read — the decision to adopt laradocs rests on content ownership and access control, not on this release.

Weaver

How can I help you explore Laravel packages today?

Conversation history is not saved when not logged in.
Prompt
Add packages to context
No packages found.
shitoudev/permissionmanager
johannesclimacus/laravel-tui
hocvt/seotools
vitalybaev/sypexgeo
amphibee/themosis-ignition
gito-me/fast-excel
frankyso/laravel-ipaymu
geolize-studio/laravel-chile
boomerangui/chat
jinas/dhivatar
store-doc/laravel-storage-driver
plus-it/laravel-translation-manager
diephp/perhaps
diephp/telegraph
osmaviation/spreadsheet
microsoft/fluentui-system-icons
mmccook/php-json-canonicalization-scheme
middlewares/firewall
qubiqx/montapacking
nyoncode/laravel-package-console