Skip to content

Commit cbce013

Browse files
Remove skills directory and usethis-specific references from usethis-agents SKILL.md
Make the skill content generic: describe the one-source-of-truth principle and AGENTS.md maintenance without usethis-specific examples or embedding the skills directory table. Remove SKILL.md from check-doc-sync args since it no longer has sync blocks. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/302a3e52-f9ad-432d-be31-b887e9ccb2f1 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
1 parent 3c69a29 commit cbce013

2 files changed

Lines changed: 3 additions & 41 deletions

File tree

.agents/skills/usethis-agents/SKILL.md

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,7 @@ When providing reference material about code objects (functions, classes, module
1717

1818
Manually maintained reference material inevitably drifts out of sync with the code it describes. Docstrings live alongside the code, are reviewed during code changes, and can be mechanically extracted — ensuring the documentation always reflects reality.
1919

20-
### How it works in this project
21-
22-
- **Module tree**: `hooks/export-module-tree.py` scans Python modules, extracts the first line of each module docstring, and writes a formatted tree to `docs/module-tree.txt`. This is synced into `AGENTS.md` via `<!-- sync:docs/module-tree.txt -->` markers.
23-
- **Skills directory**: `hooks/export-skills-directory.py` scans `usethis-*` skill directories, extracts the `name` and `description` from each `SKILL.md` frontmatter, and writes a formatted table to `docs/skills-directory.txt`.
24-
- **Sync enforcement**: `hooks/check-doc-sync.py` verifies that content between `<!-- sync:path -->` markers in markdown files matches the referenced source file.
25-
- **Skills documentation check**: `hooks/check-skills-documented.py` verifies that every skill directory is listed in `AGENTS.md`.
26-
27-
### Applying the principle
20+
### How to apply the principle
2821

2922
When you need to add reference material about code to agent configuration:
3023

@@ -47,35 +40,4 @@ Content between `<!-- sync:path/to/file -->` and `<!-- /sync:path/to/file -->` m
4740

4841
### Skills registry
4942

50-
The usethis-specific skills table in `AGENTS.md` must include every skill directory under `.agents/skills/` that starts with `usethis-`. The `check-skills-documented` hook enforces this. When creating a new skill, add it to the table (see the `usethis-skills-create` skill for the full procedure).
51-
52-
## Skills Directory
53-
54-
<!-- sync:docs/skills-directory.txt -->
55-
56-
| Skill | Description |
57-
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
58-
| `usethis-agents` | Maintain AGENTS.md and agent skill configuration following the one-source-of-truth principle |
59-
| `usethis-cli-modify` | Modify the usethis CLI layer (commands, options, help text) and keep documentation in sync |
60-
| `usethis-file-remove` | Remove files from the project |
61-
| `usethis-github-actions-update` | Update GitHub Actions workflows |
62-
| `usethis-github-issue-create` | Create GitHub issues via the gh CLI to record lessons, track follow-up work, or file bugs discovered during development |
63-
| `usethis-pre-commit` | Guidance on pre-commit hooks — this project uses prek, not pre-commit directly |
64-
| `usethis-prek-add-hook` | Add a prek hook for dev |
65-
| `usethis-prek-hook-bespoke-create` | Write bespoke prek hooks as Python scripts for custom project-specific checks |
66-
| `usethis-python-code` | Guidelines for Python code design decisions such as when to share vs. duplicate code |
67-
| `usethis-python-code-modify` | Modify Python code (e.g. refactor, add new code, or delete code) |
68-
| `usethis-python-enum` | Style and testing conventions for working with Python enums |
69-
| `usethis-python-functions` | Guidelines for Python function design, including return types and signature simplicity |
70-
| `usethis-python-module-layout-modify` | Modify the Python module layout (create, move, rename, or delete modules) |
71-
| `usethis-python-ruff` | Guidelines for complying with Ruff linter rules instead of suppressing them |
72-
| `usethis-python-test-affected-find` | Identify tests that are potentially affected by code changes, to catch regressions before CI |
73-
| `usethis-python-test-full-coverage` | Write tests that achieve full code coverage and verify coverage locally before pushing |
74-
| `usethis-qa-import-linter` | Use the Import Linter software on the usethis project |
75-
| `usethis-qa-static-checks` | Perform static code checks |
76-
| `usethis-skills-create` | Create new agent skills (SKILL.md files) following best practices for content quality, structure, and discoverability |
77-
| `usethis-skills-external-add` | Add an external (community) skill to the project from a third-party source, including installing it and documenting it in AGENTS.md |
78-
| `usethis-skills-external-install` | Reinstall already-tracked external skills from skills-lock.json (e.g. after a fresh clone) |
79-
| `usethis-skills-modify` | Modify agent skills (SKILL.md files) |
80-
81-
<!-- /sync:docs/skills-directory.txt -->
43+
The skills table in `AGENTS.md` must include every skill directory under `.agents/skills/`. The `check-skills-documented` hook enforces this. When creating a new skill, add it to the table (see the `usethis-skills-create` skill for the full procedure).

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ repos:
8888
- id: check-doc-sync
8989
name: check-doc-sync
9090
entry: uv run --frozen --offline hooks/check-doc-sync.py
91-
args: ["AGENTS.md", ".agents/skills/usethis-agents/SKILL.md"]
91+
args: ["AGENTS.md"]
9292
language: system
9393
always_run: true
9494
pass_filenames: false

0 commit comments

Comments
 (0)