docs-update

Update README.md to match the current codebase (components, composables, pages, config). Trigger phrases (English or Italian) — "update the documentation", "update the README", "aggiorna la documentazione".

Jump to install

Repository: stefanBid/sb-template-nuxt
Last source activity: August 25, 2026 at 16:54
Detected SKILL.md language: English
Stars: 2
Forks: 0

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/stefanBid/sb-template-nuxt --skill docs-update

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

name	docs-update
description	Update README.md to match the current codebase (components, composables, pages, config). Trigger phrases (English or Italian) — "update the documentation", "update the README", "aggiorna la documentazione".

Update documentation

Read in parallel: README.md, package.json, nuxt.config.ts, CLAUDE.md, the full app/ directory (components, composables, pages, layouts), i18n/locales/en.json.
Compare the README against the actual codebase: outdated sections, missing sections (new components/composables/pages/conventions), incorrect versions, broken links. Report the differences briefly, then proceed without waiting for approval.
Rewrite README.md (English), keeping its existing 13-section structure (Overview, Getting Started, Project Structure, Design System, Routing, Layouts, Pages, Components, Composables & Utils, AI Tooling, Deployment, Versioning, Dependencies). Sections AI Tooling and Deployment are mandatory — always present. Don't invent information; mark unverifiable details as TBD.
Confirm what changed and note any TBD sections that need user input.

See the "Documentation sync rule" in the project's root CLAUDE.md for when this workflow must run proactively (not just on explicit request).

docs-update

Source facts

Install options

Review the source files

More from this repository

More from this repository

Update documentation

Update documentation