updating-docs
CommunityStreamline Peek documentation updates
Content & Communication#documentation#docs#regenerate#api-reference#style-guide#mkdocs#mkdocs-material
Authorcarrotwaxr
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Provides a consistent, repeatable process for creating and updating project documentation for peek-stash-browser, preventing broken links, inconsistent styles, and stale API references.
Core Features & Use Cases
- Guides authors to use MkDocs with the Material theme and to place content in the correct docs/ subdirectories (getting-started, user-guide, development, reference, plans).
- Documents the automated API reference generation from TypeScript via server/scripts/generate-api-docs.ts and the CI triggers that rebuild the site on relevant source changes.
- Covers redirects, local preview, design and implementation plan templates, and conventions for page structure, admonitions, and troubleshooting; useful when adding features, updating installation steps, or moving pages.
Quick Start
Update the getting-started/installation.md page to document Docker and JWT setup, then regenerate the API reference by running the server scripts to rebuild docs.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: updating-docs Download link: https://github.com/carrotwaxr/peek-stash-browser/archive/main.zip#updating-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.