mrpunyapal/laravel-extended-commands/docsmith-docs

Writing Docs with Docsmith

Use the docsmith MCP tools in this order:

1. Explore — read_source list_files (pattern **/*), read_source analyze_structure

on source directories, and read_source read_file on the key files.

1. Plan — a focused page set: index.md (landing), installation.md,

configuration.md, usage.md, commands.md, api.md.

1. Write — write_markdown create_page for each page (or update_page to revise).
2. Capture evidence — capture_media for real UI screenshots and videos

(see below).

1. Build — build_site to render the static site.
2. Iterate — review built pages, fix weak ones, rebuild.

Page conventions

• Lowercase kebab-case paths ending in .md; index.md is the landing page.
• H1 title, one-paragraph overview, H2 sections.
• Real, runnable code examples with language tags; tables for command/option lists.
• Only document what read_source shows — never invent API.

Capturing real UI evidence

When the project has a UI (admin panel, components, dashboards), boot it and capture real screenshots instead of describing features in prose:

1. Start the app (e.g. php artisan serve) and note the URL.
2. capture_media with action: "screenshot" for stills — pass viewport

(e.g. 1280x720), selector to frame one component, wait_for when the page loads async content, dark: true for dark-mode shots.

1. capture_media with action: "video" plus steps for short workflow demos:

``json {"steps": [ {"action": "fill", "selector": "#email", "value": "user@example.com"}, {"action": "click", "selector": "#login"}, {"action": "wait", "selector": ".dashboard"}, {"action": "wait", "ms": 500} ]} ``

Keep videos under ~15 seconds and under ~2 MB — they ship inside the repo.

1. Both actions return path (e.g. media/dashboard.png) — embed it with

write_markdown insert_media, or reference ![](media/dashboard.png) directly.

1. If capture_media returns an install error, tell the user to run

npm install -D playwright capturist && npx playwright install chromium.

Use captures when they show something code cannot: rendered UI, visual states, multi-step flows. Skip them for pure API/CLI documentation.