OpenParable
Skip to content
← Back to skills

Update Spatie Docs

Documents
update-spatie-docs

Update Spatie Docs is an Agent Skill for documents published in the freekmurze/dotfiles repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Update Spatie package documentation on spatie.be by re-importing docs for a given repo. Use after merging a PR that touches docs/, or when the user says 'update docs for [package]', 'rebuild docs for [repo]', 'import docs for [repo]', or invokes /update-spatie-docs [repo-name]. Takes a repo name argument (e.g., 'backup', 'laravel-medialibrary', 'laravel-pdf').

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/freekmurze/dotfiles/blob/HEAD/config/claude/skills/update-spatie-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/update-spatie-docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Update Spatie Docs

The spatie.be docs site does not rebuild automatically after a PR merges. To publish doc changes, run the docs:import artisan command against the repo.

Command

Run this twice to be sure (the second run catches any version that lagged on the first pass):

cd /Users/freek/dev/code/spatie.be && ar "docs:import --repo=spatie/{repo_name}"
cd /Users/freek/dev/code/spatie.be && ar "docs:import --repo=spatie/{repo_name}"

ar is a shell alias for php artisan remote, so this runs the command against the production spatie.be instance.

If no repo name argument is provided, ask the user for one.

Verification

After running, curl a docs URL to confirm the new content is live. The import sometimes returns success before the published pages reflect it, so check a specific page you changed:

curl -sL "https://spatie.be/docs/{repo_name}/v2/some-page-you-changed" | grep -oE '<title>[^<]*</title>'

If the title matches the fallback (Introduction page) instead of the page you expected, the cache has not caught up yet. Wait a moment and curl again.