ecommerce-api-docs

Generate Laravel API documentation from PHPDoc annotations using Scribe.

Updated Apr 6, 2026

Search Tags:#documentation #multi-tenant #api #laravel #phpdoc #scribe

Ready to run

npx skills add https://github.com/vinocrzy/StoreForge --skill ecommerce-api-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ecommerce-api-docs
Source: https://github.com/vinocrzy/StoreForge/tree/main/.github/skills/ecommerce-api-docs
Command: npx skills add https://github.com/vinocrzy/StoreForge --skill ecommerce-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates API documentation generation for Laravel controllers in a multi-tenant backend using Scribe, ensuring consistent, up-to-date docs across stores.

Core Features & Use Cases

Automates setup, annotation parsing, and doc generation for Laravel API controllers with PHPDoc annotations.
Regenerates API docs after changes to endpoints, keeping the documentation in sync with the codebase (Platform: Laravel backend, Scribe integration).
Use Case: When adding a new endpoint or modifying an existing one, run the setup for initial configuration and then generate documentation to publish.

Quick Start

Run the documentation workflow to install Scribe and generate docs for your controllers.

Frequently Asked Questions about ecommerce-api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate Laravel API documentation generation with Scribe?▼

You can automate Laravel API documentation generation by using Scribe to parse PHPDoc annotations in your controllers, which extracts endpoint metadata and outputs structured docs. This workflow handles setup, annotation parsing, and document publishing.

Can I regenerate API docs for a multi-tenant Laravel backend after updating endpoints?▼

Yes, you can regenerate API docs for a multi-tenant Laravel backend to keep documentation in sync with codebase changes. Running the documentation workflow updates existing endpoint docs and incorporates newly added controllers across multiple stores.

Do I need PHPDoc annotations in controllers to generate Scribe documentation?▼

Yes, PHPDoc annotations in your Laravel controllers are required to generate accurate Scribe documentation. Scribe parses these annotations to extract endpoint details, request parameters, and response structures for the final API docs.

What is the best way to keep API documentation in sync with a Laravel codebase?▼

The best way to keep API documentation in sync with a Laravel codebase is to automate generation using Scribe. By parsing PHPDoc annotations directly from controllers, it ensures docs reflect current endpoint logic without manual updates.

Does this Scribe documentation workflow support adding new Laravel API endpoints?▼

Yes, this Scribe documentation workflow supports adding new Laravel API endpoints. When you create a new endpoint with proper PHPDoc annotations, running the generation process automatically detects the controller and incorporates the new route into the published docs.