القائمة
Use when creating or updating documentation in peek-stash-browser. Covers MkDocs conventions, doc structure, API reference generation, and plan document formatting.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when writing tests for peek-stash-browser. Covers Vitest + React Testing Library (client) and Vitest + integration testing (server). Follow these conventions exactly.
Run all validation checks before tagging a new release
Use when starting a new coding session, beginning work on a branch, or resuming after a context reset. Gathers branch context, in-progress work, plan documents, and recent history to produce a briefing before any code is written.
Perform a code quality review before creating a PR. Use when reviewing changes, checking code quality, or doing a self-review of the current branch. Invoked as part of the work-ticket lifecycle after verification-before-completion and before finishing-a-development-branch.
Use when preparing or executing a release of peek-stash-browser. Covers the full release lifecycle from validation through Docker image publishing.
Express 5 patterns for peek-stash-browser — TypeScript backend serving a React SPA with HLS video proxying, multi-instance Stash server routing, JWT auth via HTTP-only cookies, and SQLite via Prisma. Use when writing or modifying Express route handlers, middleware, proxy controllers, or streaming endpoints in the peek project.
| name | updating-docs |
| description | Use when creating or updating documentation in peek-stash-browser. Covers MkDocs conventions, doc structure, API reference generation, and plan document formatting. |
server/scripts/generate-api-docs.tsdocs/
index.md # Landing page
getting-started/ # Installation, config, troubleshooting (6 files)
user-guide/ # Feature documentation (14 files)
development/ # Developer docs (4 files)
reference/ # API reference, entity relationships, Docker basics
plans/ # Design docs and implementation plans (~120 files)
audits/ # Documentation audits
assets/ # Images, logos
stylesheets/ # Custom CSS
javascripts/ # Custom JS
# Feature Name
Brief description of what this feature does and why it's useful.
## Section Name
Step-by-step instructions or explanation.
### Subsection
More detail as needed.
!!! tip
Helpful hint for the user.
!!! warning
Important caution about potential issues.
!!! info
Additional context or background information.
!!! tip, !!! warning, !!! info, !!! note for callouts[Link Text](../user-guide/playlists.md)bash, json, etc.)| Content | Directory |
|---|---|
| How to install/configure | getting-started/ |
| How to use a feature | user-guide/ |
| How the code works | development/ |
| API endpoints, entity models | reference/ |
| Feature design before implementation | plans/ |
docs/plans/YYYY-MM-DD-feature-name-type.md
Types:
-design.md — Problem statement, proposed solution, architecture decisions-plan.md — Task-by-task implementation steps-impl.md or -implementation.md — Detailed implementation notes# Feature Name
## Objective
Brief statement of what we're building and why.
## Current State
What exists today, what's missing or broken.
## Solution
### Approach
High-level description of the solution.
### Changes
#### File: `path/to/file.ts`
- Description of changes with code context
## Files Affected
- `path/to/file.ts` — description
# Feature Name — Implementation Plan
## Goal
One-line goal.
## Architecture
Brief architecture summary.
---
### Task 1: Task Title
**Files:**
- Modify: `path/to/file.ts`
- Create: `path/to/new-file.ts`
**Steps:**
1. Step description
2. Step description
**Verification:** `npm test` or manual check description.
---
### Summary
| Task | Description | Files |
|------|-------------|-------|
| 1 | Task title | file.ts |
The API reference at docs/reference/api-reference.md is auto-generated. Do not edit it manually.
cd server && npm run generate-api-docs
This parses route files, controller implementations, and TypeScript type definitions to generate the reference. It runs automatically in CI when relevant source files change.
The docs GitHub Action rebuilds when these paths change:
docs/**mkdocs.ymlserver/routes/**server/types/api/**server/controllers/**server/scripts/**When moving a doc to a new path, add a redirect in mkdocs.yml:
plugins:
- redirects:
redirect_maps:
'old/path.md': 'new/path.md'
pip install mkdocs-material mkdocs-minify-plugin mkdocs-redirects
mkdocs serve
Site available at http://localhost:8000.