Organize documentation into topic folders (Claude, Python, Zscaler, Project template)
This commit is contained in:
@@ -0,0 +1,8 @@
|
||||
---
|
||||
name: changelog
|
||||
description: Updates changelog in project
|
||||
---
|
||||
|
||||
Take known info and make changes to CHANGELOG.md to make them up-to-date.
|
||||
|
||||
Ignore changes to: `docs/`, `CONTEXT.md`, `Documentation_AI.md`, `Documentation_human.md` — documentation and context files are not logged in the changelog.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
name: check
|
||||
description: Check for failed tests
|
||||
---
|
||||
Try running tests and investigate failed results
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
name: commit
|
||||
description: Updates changelog and proposes a concise verbal git commit message
|
||||
---
|
||||
|
||||
1. Run the changelog skill: read git log and staged changes, then update CHANGELOG.md accordingly (same as /changelog).
|
||||
|
||||
2. Propose a single-line verbal commit message:
|
||||
- Concise, verbal style — e.g. "Add X", "Fix Y", "Refactor Z"
|
||||
- NOT filename-style — never "update_something.py" or "changes to foo"
|
||||
- In English
|
||||
- Do NOT run git commit — only propose the message and wait for user confirmation.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: context
|
||||
description: Compress docs/ into CONTEXT.md at project root — minimum tokens, lossless
|
||||
---
|
||||
|
||||
Read every `.md` file in `docs/`. Generate `CONTEXT.md` at the project root.
|
||||
|
||||
## Goal
|
||||
|
||||
Lossless compression of `docs/` into a single file optimised for LLM context window use.
|
||||
Every public function, class, constant, invariant, file path, and edge case from `docs/` must be present.
|
||||
Target: CONTEXT.md ≈ 40–50% byte size of combined `docs/` input.
|
||||
|
||||
## Format rules
|
||||
|
||||
- Symbol legend at top: `Legend: → returns * required ? optional @ located at`
|
||||
- Tables over paragraphs — always
|
||||
- Compact signature notation: `f(a:T, b:T) → T @ src/foo.py`
|
||||
- Pipe unions: `A | B | C`
|
||||
- Section references: §0, §1, … — state each fact once, reference elsewhere
|
||||
- Inline conditions: `if X: Y; else: Z`
|
||||
- No prose, no motivation, no examples that just illustrate a stated rule
|
||||
- No headings deeper than 3 levels
|
||||
|
||||
## Sections
|
||||
|
||||
- §0 Module map — path + 1-line role
|
||||
- §1 Data types — every class: fields, types, invariants
|
||||
- §2 Public API — every public function/method: compact signature + constraints
|
||||
- §3 Constants — table: name, value, file, where used
|
||||
- §4 Workflows — compact arrow notation
|
||||
- §5 Configuration — env vars, defaults
|
||||
- §6 Edge cases & invariants — one row per rule, exhaustive
|
||||
- §7 Build / run / test — exact commands
|
||||
|
||||
## When to skip
|
||||
|
||||
If `CONTEXT.md` exists and no file in `docs/` is newer than it: print `context: in sync` and stop.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
name: documentation
|
||||
description: Updates documentation in project
|
||||
---
|
||||
Create or update documentation of project in docs/ folder. Documentation should contain description of each part of program and documentation of each function. Separate documents for each module. Write in markdown format.
|
||||
Reference in New Issue
Block a user