Skip to content

Commit f008eb3

Browse files
robertgussclaude
robertguss
and
claude
committed
Add project documentation (LICENSE, CONTRIBUTING, CHANGELOG)
- Add MIT LICENSE.md for legal clarity - Add CONTRIBUTING.md with guidelines for skills, hooks, templates - Add CHANGELOG.md with version history from git commits - Add skill-connections guide explaining how skills work together - Update README.md with quick start and progressive disclosure - Update mkdocs.yml navigation with skill connections - Add .doc-state.json manifest for documentation tracking Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 71b5027 commit f008eb3

8 files changed

Lines changed: 523 additions & 2 deletions

File tree

‎.doc-state.json‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
{
2+
"version": "1.0",
3+
"project": {
4+
"name": "claude-code-toolkit",
5+
"type": "skill-toolkit",
6+
"lastScanned": "2026-01-19T00:00:00Z",
7+
"gitCommit": "71b5027"
8+
},
9+
"preferences": {
10+
"audiences": ["developers", "users"],
11+
"depthLevel": "standard",
12+
"tone": "professional"
13+
},
14+
"healthScore": {
15+
"overall": 88,
16+
"components": {
17+
"coverage": 90,
18+
"freshness": 95,
19+
"quality": 85,
20+
"consistency": 82
21+
},
22+
"previousScore": 75,
23+
"trend": [75, 88]
24+
},
25+
"coverage": {
26+
"skills": {
27+
"total": 6,
28+
"documented": 6,
29+
"notes": "All main skills have READMEs"
30+
},
31+
"hooks": {
32+
"total": 3,
33+
"documented": 3,
34+
"notes": "All hooks have READMEs"
35+
},
36+
"templates": {
37+
"total": 10,
38+
"documented": 10,
39+
"notes": "templates/README.md covers all"
40+
},
41+
"plugins": {
42+
"total": 1,
43+
"documented": 1,
44+
"notes": "compound-writing has README"
45+
},
46+
"projectFiles": {
47+
"total": 4,
48+
"documented": 4,
49+
"notes": "README, LICENSE, CONTRIBUTING, CHANGELOG all present"
50+
}
51+
},
52+
"debt": {
53+
"critical": [],
54+
"important": [],
55+
"minor": [
56+
{
57+
"item": "build.py could have more inline documentation",
58+
"effort": "low",
59+
"status": "accepted"
60+
},
61+
{
62+
"item": "End-to-end workflow examples could be expanded",
63+
"effort": "medium",
64+
"status": "accepted"
65+
}
66+
]
67+
},
68+
"documentationMap": {
69+
"README.md": {
70+
"lastUpdated": "2026-01-19T00:00:00Z",
71+
"covers": ["overview", "quickstart", "structure"],
72+
"wordCount": 850
73+
},
74+
"LICENSE.md": {
75+
"lastUpdated": "2026-01-19T00:00:00Z",
76+
"covers": ["legal"],
77+
"wordCount": 170
78+
},
79+
"CONTRIBUTING.md": {
80+
"lastUpdated": "2026-01-19T00:00:00Z",
81+
"covers": ["contribution-guidelines"],
82+
"wordCount": 450
83+
},
84+
"CHANGELOG.md": {
85+
"lastUpdated": "2026-01-19T00:00:00Z",
86+
"covers": ["version-history"],
87+
"wordCount": 380
88+
},
89+
"docs/concepts/skill-connections.md": {
90+
"lastUpdated": "2026-01-19T00:00:00Z",
91+
"covers": ["skill-relationships", "workflows", "combinations"],
92+
"wordCount": 750
93+
}
94+
},
95+
"sessionHistory": [
96+
{
97+
"date": "2026-01-19T00:00:00Z",
98+
"mode": "comprehensive",
99+
"changes": [
100+
"Created LICENSE.md",
101+
"Created CONTRIBUTING.md",
102+
"Created CHANGELOG.md",
103+
"Created docs/concepts/skill-connections.md",
104+
"Updated README.md with quick start and links",
105+
"Updated docs/concepts/index.md with skill connections",
106+
"Updated mkdocs.yml navigation"
107+
],
108+
"healthScoreBefore": 75,
109+
"healthScoreAfter": 88
110+
}
111+
]
112+
}

‎CHANGELOG.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
## [Unreleased]
6+
7+
### Added
8+
- Documentation improvements with LICENSE.md, CONTRIBUTING.md, and CHANGELOG.md
9+
- Skill connections guide explaining how skills work together
10+
11+
## [2026-01-18] - Compound Writing Plugin
12+
13+
### Added
14+
- **compound-writing plugin** — Complete writing system with:
15+
- 6 specialized agents (clarity-editor, fact-checker, publishing-optimizer, researcher, structure-architect, voice-guardian)
16+
- 4 workflow commands (plan, draft, review, compound)
17+
- 5 writing skills (dhh-writing, every-style-editor, pragmatic-writing, voice-capture, writing-orchestration)
18+
- Pattern capture system for learning from successful writing
19+
20+
## [2026-01-15] - Toolkit Restructure
21+
22+
### Changed
23+
- **Major restructure** — Rebranded from "Claude Skills" to "Claude Code Toolkit"
24+
- Reorganized all skills into `skills/` directory
25+
- Created `hooks/` directory for event handlers
26+
- Created `templates/` directory for configuration templates
27+
28+
### Added
29+
- **handoff skill** — Session continuity documents for context preservation
30+
- **Templates collection** — HUMAN.md, CLAUDE.md guides, compaction strategy, prompt guides
31+
- Expanded template documentation
32+
33+
## [2026-01-10] - Code Documenter
34+
35+
### Added
36+
- **code-documenter skill** — Intelligent documentation generation with:
37+
- Multi-agent analysis
38+
- Documentation health scoring
39+
- Architecture Decision Records (ADRs)
40+
- Quality gates throughout generation
41+
42+
## [2026-01-03] - Documentation Site
43+
44+
### Added
45+
- **MkDocs documentation site** with Material theme
46+
- GitHub Pages deployment via GitHub Actions
47+
- Developer guide, concept documentation, skill catalog
48+
- Getting started tutorials
49+
50+
### Changed
51+
- Restored build.py packaging system
52+
- Switched to uv package manager
53+
54+
## [2025-12-31] - Writing Skills
55+
56+
### Added
57+
- **ebook-factory** — Focused ebook creation pipeline
58+
- **non-fiction-book-factory** — Full pipeline from idea to chapter architecture
59+
- **writing** — Voice capture and ghost writing
60+
- **skill-creator** — Tool for creating new skills
61+
62+
### Changed
63+
- Integrated multiple writing-focused PRs (#1, #2, #3)
64+
65+
## [2025-12-29] - Initial Release
66+
67+
### Added
68+
- **brainstorm skill** — Multi-session ideation partner with 25+ brainstorming methods
69+
- Basic project structure
70+
- Initial build system for skill packaging

‎CONTRIBUTING.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing to Claude Code Toolkit
2+
3+
Thank you for your interest in contributing. This guide covers how to submit skills, hooks, templates, or improvements.
4+
5+
## Types of Contributions
6+
7+
### Skills
8+
9+
Skills are packaged workflows that give Claude domain expertise. To add a skill:
10+
11+
1. Create a directory under `skills/` with your skill name
12+
2. Add a `SKILL.md` file with required YAML frontmatter:
13+
14+
```yaml
15+
---
16+
name: your-skill-name
17+
description: "A description of at least 20 characters explaining what this skill does"
18+
---
19+
20+
# Your Skill Instructions
21+
22+
[Detailed instructions for Claude to follow...]
23+
```
24+
25+
3. Add a `README.md` explaining:
26+
- What the skill does
27+
- When to use it
28+
- How to invoke it
29+
- Example usage
30+
31+
4. Optionally add:
32+
- `references/` — Supporting documentation loaded on demand
33+
- `assets/` — Templates, examples, configurations
34+
35+
**Validation:** Run `python build.py --list` to verify your skill passes validation.
36+
37+
### Hooks
38+
39+
Hooks are shell scripts that run at specific Claude Code events. To add a hook:
40+
41+
1. Create a directory under `hooks/` with your hook name
42+
2. Add the hook script (e.g., `your-hook.sh`)
43+
3. Add a `README.md` covering:
44+
- What event triggers it (`PostToolUse`, `Stop`, `PreCompact`)
45+
- What the hook does
46+
- Installation instructions
47+
- Configuration options
48+
49+
### Templates
50+
51+
Templates are starting points for Claude configuration files. To add a template:
52+
53+
1. Add your template to the `templates/` directory
54+
2. Update `templates/README.md` with your template's purpose and usage
55+
56+
### Bug Fixes and Improvements
57+
58+
1. Fork the repository
59+
2. Create a feature branch
60+
3. Make your changes
61+
4. Submit a pull request
62+
63+
## Development Setup
64+
65+
```bash
66+
# Clone your fork
67+
git clone https://github.com/YOUR_USERNAME/claude-code-toolkit.git
68+
cd claude-code-toolkit
69+
70+
# Install dependencies
71+
just install
72+
73+
# Validate skills
74+
python build.py --list
75+
76+
# Test documentation locally
77+
just docs-serve
78+
```
79+
80+
## Skill Guidelines
81+
82+
**Do:**
83+
- Write clear, actionable instructions
84+
- Include examples
85+
- Document when to use (and when not to use) the skill
86+
- Keep the scope focused
87+
88+
**Don't:**
89+
- Create skills that duplicate existing functionality
90+
- Include sensitive information or API keys
91+
- Write instructions that are vague or open to interpretation
92+
93+
## Code Style
94+
95+
- Python: Format with `ruff`
96+
- Shell: Use `#!/bin/bash` and handle errors
97+
- Markdown: Use consistent heading hierarchy
98+
99+
## Questions?
100+
101+
Open an issue for questions about contributing.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2025-2026 Robert Guss
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Claude Code Toolkit
22

3-
A collection of skills, hooks, and templates that extend Claude Code with specialized workflows and better defaults.
3+
Extend Claude Code with specialized workflows, automatic formatting, and better defaults.
4+
5+
**Skills** give Claude domain expertise—brainstorming methods, documentation generation, book writing pipelines. **Hooks** automate repetitive tasks—format code after edits, summarize changes at session end. **Templates** configure how Claude works with you.
6+
7+
Works with both Claude Code (CLI) and Claude.ai (web/mobile/desktop).
8+
9+
## Quick Start
10+
11+
```bash
12+
# Clone the toolkit
13+
git clone https://github.com/robertguss/claude-code-toolkit.git
14+
15+
# Use a skill in Claude Code
16+
# Add to your project's CLAUDE.md:
17+
echo "When brainstorming, read /path/to/claude-code-toolkit/skills/brainstorm/SKILL.md" >> CLAUDE.md
18+
19+
# Or package for Claude.ai
20+
python build.py brainstorm
21+
# Upload dist/brainstorm.skill to Claude.ai → Settings → Skills
22+
```
423

524
## What's Included
625

@@ -149,6 +168,10 @@ just package brainstorm
149168
just
150169
```
151170

171+
## Contributing
172+
173+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting skills, hooks, or improvements.
174+
152175
## License
153176

154-
Personal use. Modify freely.
177+
MIT License. See [LICENSE.md](LICENSE.md) for details.

‎docs/concepts/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ Understanding the key ideas behind how Claude Skills work.
3232

3333
Different operating modes skills offer for different situations.
3434

35+
- :material-link-variant:{ .lg .middle } **[Skill Connections](skill-connections.md)**
36+
37+
---
38+
39+
How skills relate to each other and can be combined for complex workflows.
40+
3541
</div>
3642

3743
---
@@ -46,6 +52,7 @@ Skills aren't just instruction sets—they're designed systems with specific pat
4652
| **Session Continuity** | Creative work happens over time, not in one sitting |
4753
| **Handoffs** | Each specialist needs clear input from the previous |
4854
| **Modes** | Different situations need different approaches |
55+
| **Skill Connections** | Complex projects need multiple skills working together |
4956

5057
---
5158

@@ -86,3 +93,4 @@ A typical workflow combines all these concepts:
8693
- [:octicons-arrow-right-24: Session Continuity](session-continuity.md) — How work persists across time
8794
- [:octicons-arrow-right-24: Handoffs](handoffs.md) — What passes between skills
8895
- [:octicons-arrow-right-24: Modes & Registers](modes-and-registers.md) — Adapting to different situations
96+
- [:octicons-arrow-right-24: Skill Connections](skill-connections.md) — Combining skills for complex workflows

0 commit comments

Comments
 (0)