Skip to content

Commit 22f8478

Browse files
Vlad Goncharovgitbook-bot
authored andcommitted
GITBOOK-3: Update Guides description
1 parent e98515f commit 22f8478

File tree

5 files changed

+201
-128
lines changed

5 files changed

+201
-128
lines changed

docs/README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# Welcome to Context Engineering Kit
1+
---
2+
icon: brain-circuit
3+
---
4+
5+
# Context Engineering Kit
26

37
The Context Engineering Kit (CEK) is a curated marketplace of advanced context engineering techniques and patterns designed specifically for Claude Code. It provides prompts for extensibly tested and benchmarked techniques that enhance LLM output quality, speficially focusing on code genration, research and problem solving.
48

59
## Key Features
610

7-
- **Simple to Use** - Easy to install and use without any dependencies. Contains automatically used skills and self-explanatory commands.
8-
- **Token-Efficient** - Carefully crafted prompts and architecture, preferring commands over skills, to minimize populating context with unnecessary information.
9-
- **Quality-Focused** - Each plugin is focused on meaningfully improving agent results in a specific area.
10-
- **Granular** - Install only the plugins you need. Each plugin loads only its specific agents, commands, and skills. Each without overlap and redundant skills.
11-
- **Scientifically proven** - Plugins are based on proven techniques and patterns that were tested by well-trusted benchmarks and studies, with exception to development workflows that based on popular projects and frameworks.
11+
* **Simple to Use** - Easy to install and use without any dependencies. Contains automatically used skills and self-explanatory commands.
12+
* **Token-Efficient** - Carefully crafted prompts and architecture, preferring commands over skills, to minimize populating context with unnecessary information.
13+
* **Quality-Focused** - Each plugin is focused on meaningfully improving agent results in a specific area.
14+
* **Granular** - Install only the plugins you need. Each plugin loads only its specific agents, commands, and skills. Each without overlap and redundant skills.
15+
* **Scientifically proven** - Plugins are based on proven techniques and patterns that were tested by well-trusted benchmarks and studies, with exception to development workflows that based on popular projects and frameworks.
1216

1317
## IDEs and CLIs support
1418

@@ -18,37 +22,37 @@ Currenty this project support only Claude Code CLI, but we plan to support other
1822

1923
Start here to get up and running quickly:
2024

21-
- [Getting Started](getting-started.md) - Installation, setup, and your first plugin
22-
- [User Guide](user-guide.md) - Common workflows and usage patterns
23-
- [Core Concepts](concepts/) - Understanding context engineering principles
25+
* [Getting Started](getting-started.md) - Installation, setup, and your first plugin
26+
* [User Guide](user-guide.md) - Common workflows and usage patterns
27+
* [Core Concepts](concepts/) - Understanding context engineering principles
2428

2529
## Explore Plugins
2630

2731
Browse our specialized plugins organized by area of focus:
2832

2933
### Quality & Refinement
3034

31-
- [Reflexion](plugins/reflexion/README.md) - Self-refinement loops (8-21% quality improvement)
32-
- [Code Review](plugins/code-review/README.md) - Multi-agent code review system
33-
- [Kaizen](plugins/kaizen/README.md) - Continuous improvement methodology
35+
* [Reflexion](plugins/reflexion/) - Self-refinement loops (8-21% quality improvement)
36+
* [Code Review](plugins/code-review/) - Multi-agent code review system
37+
* [Kaizen](plugins/kaizen/) - Continuous improvement methodology
3438

3539
### Development Workflows
3640

37-
- [Spec-Driven Development](plugins/sdd/README.md) - Feature specification to implementation
38-
- [Test-Driven Development](plugins/tdd/README.md) - TDD methodology and anti-patterns
39-
- [Subagent-Driven Development](plugins/sadd/README.md) - Task isolation with quality gates
40-
- [Domain-Driven Development](plugins/ddd/README.md) - Clean Architecture and SOLID principles
41+
* [Spec-Driven Development](plugins/sdd/) - Feature specification to implementation
42+
* [Test-Driven Development](plugins/tdd/) - TDD methodology and anti-patterns
43+
* [Subagent-Driven Development](plugins/sadd/) - Task isolation with quality gates
44+
* [Domain-Driven Development](plugins/ddd/) - Clean Architecture and SOLID principles
4145

4246
### Developer Tools
4347

44-
- [Git](plugins/git/README.md) - Commit creation and PR management
45-
- [Docs](plugins/docs/README.md) - Documentation generation and updates
46-
- [Tech Stack](plugins/tech-stack/README.md) - Language and framework best practices
48+
* [Git](plugins/git/) - Commit creation and PR management
49+
* [Docs](plugins/docs/) - Documentation generation and updates
50+
* [Tech Stack](plugins/tech-stack/) - Language and framework best practices
4751

4852
### Agents Implevements and Extensions
4953

50-
- [Customaize Agent](plugins/customaize-agent/README.md) - Build your own commands and skills
51-
- [MCP](plugins/mcp/README.md) - Model Context Protocol server integration
54+
* [Customaize Agent](plugins/customaize-agent/) - Build your own commands and skills
55+
* [MCP](plugins/mcp/) - Model Context Protocol server integration
5256

5357
## Contributing
5458

docs/SUMMARY.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Table of contents
2+
3+
* [Context Engineering Kit](README.md)
4+
* [Getting Started](getting-started.md)
5+
* [Guides](guides/README.md)
6+
* [Project Setup](guides/project-setup.md)
7+
* [Feature Development](guides/feature-development.md)
8+
* [Spec-Driven Development](guides/spec-driven-development.md)
9+
* [PR Review](guides/pr-review.md)
10+
* [Brainstorming Complex Feature](guides/brainstorming-to-implementation.md)
11+
* [Bug Investigation and Fix](guides/bug-investigation.md)
12+
* [Code Quality Improvement](guides/code-quality-improvement.md)
13+
* [Creating Custom Extensions](guides/custom-extensions.md)
14+
* [Plugins](plugins/README.md)
15+
* [Code Review](plugins/code-review/README.md)
16+
* [Usage Examples](plugins/code-review/usage-examples.md)
17+
* [Customize Agent](plugins/customaize-agent/README.md)
18+
* [Usage Examples](plugins/customaize-agent/usage-examples.md)
19+
* [Domain-Driven Development](plugins/ddd/README.md)
20+
* [Usage Examples](plugins/ddd/usage-examples.md)
21+
* [Docs](plugins/docs/README.md)
22+
* [Usage Examples](plugins/docs/usage-examples.md)
23+
* [Git](plugins/git/README.md)
24+
* [Kaizen](plugins/kaizen/README.md)
25+
* [Usage Examples](plugins/kaizen/usage-examples.md)
26+
* [MCP](plugins/mcp/README.md)
27+
* [Recommended MCP Servers](plugins/mcp/recommended-mcp.md)
28+
* [Usage Examples](plugins/mcp/usage-examples.md)
29+
* [Reflexion](plugins/reflexion/README.md)
30+
* [Usage Examples](plugins/reflexion/usage-examples.md)
31+
* [Subagent-Driven Development](plugins/sadd/README.md)
32+
* [Usage Examples](plugins/sadd/usage-examples.md)
33+
* [Spec-Driven Development](plugins/sdd/README.md)
34+
* [Usage Examples](plugins/sdd/usage-examples.md)
35+
* [Test-Driven Development](plugins/tdd/README.md)
36+
* [Usage Examples](plugins/tdd/usage-examples.md)
37+
* [Tech Stack](plugins/tech-stack/README.md)
38+
* [Usage Examples](plugins/tech-stack/usage-examples.md)
39+
* [Concepts](concepts.md)
40+
* [Best Practices](best-practices.md)
41+
* [Reference](reference/README.md)
42+
* [Agents](reference/agents.md)
43+
* [Commands](reference/commands.md)
44+
* [Skills](reference/skills.md)
45+
* [Resources](resources/README.md)
46+
* [Research Papers](resources/papers.md)
47+
* [Related Projects](resources/related-projects.md)

docs/getting-started.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
# Getting Started with Context Engineering Kit
1+
---
2+
description: >-
3+
This guide will help you install Context Engineering Kit to your Claude Code
4+
and start using plugins.
5+
icon: rocket
6+
---
27

3-
This guide will help you install Context Engineering Kit to your Claude Code and start using plugins.
8+
# Getting Started
49

510
## Prerequisites
611

712
Before you begin, ensure you have:
813

914
**Claude Code installed** - The official CLI tool from Anthropic
10-
- If not installed, visit [Claude Code documentation](https://docs.anthropic.com/claude/docs/claude-code) for installation instructions
1115

16+
* If not installed, visit [Claude Code documentation](https://docs.anthropic.com/claude/docs/claude-code) for installation instructions
1217

1318
## Quick Start
1419

@@ -27,10 +32,11 @@ Then add the Context Engineering Kit marketplace to make all plugins available:
2732
```
2833

2934
**What happens:**
30-
- The marketplace metadata is downloaded and cached locally
31-
- All available plugins become visible in your plugin list
32-
- No plugins are installed yet - this only makes them available
33-
- No agents, commands, or skills are loaded - your context remains clean
35+
36+
* The marketplace metadata is downloaded and cached locally
37+
* All available plugins become visible in your plugin list
38+
* No plugins are installed yet - this only makes them available
39+
* No agents, commands, or skills are loaded - your context remains clean
3440

3541
**Verify it worked:**
3642

@@ -49,9 +55,10 @@ We recommend starting with the **Reflexion plugin** - it introduces feedback and
4955
```
5056

5157
**What happens:**
52-
- The Reflexion plugin is installed in your Claude Code environment
53-
- Three new commands become available: `/reflexion:reflect`, `/reflexion:memorize`, `/reflexion:critique`
54-
- Plugin-specific skills and agents are loaded into Claude's context in future sessions
58+
59+
* The Reflexion plugin is installed in your Claude Code environment
60+
* Three new commands become available: `/reflexion:reflect`, `/reflexion:memorize`, `/reflexion:critique`
61+
* Plugin-specific skills and agents are loaded into Claude's context in future sessions
5562

5663
### Step 3: Use Your First Command
5764

@@ -67,23 +74,26 @@ Claude will provide an initial response. Now, use Reflexion to ask it to reitera
6774
/reflexion:reflect
6875
```
6976

70-
**What happens:**
71-
Claude reviews its previous response using self-refinement techniques, identifies areas for improvement, and generates an enhanced version with deeper analysis.
77+
**What happens:** Claude reviews its previous response using self-refinement techniques, identifies areas for improvement, and generates an enhanced version with deeper analysis.
7278

73-
**Expected result:**
74-
Claude will analyze its previous response critically, identify specific improvements (e.g., "I should have considered error propagation patterns"), and provide an enhanced response with more detail and better recommendations.
79+
**Expected result:** Claude will analyze its previous response critically, identify specific improvements (e.g., "I should have considered error propagation patterns"), and provide an enhanced response with more detail and better recommendations.
7580

7681
**Try the memorize command:**
7782

7883
```bash
7984
/reflexion:memorize
8085
```
8186

82-
**What happens:**
83-
Claude identifies key learnings from the interaction, updates your project's `CLAUDE.md` file with curated insights, and builds a knowledge base that future Claude sessions can leverage.
87+
**What happens:** Claude identifies key learnings from the interaction, updates your project's `CLAUDE.md` file with curated insights, and builds a knowledge base that future Claude sessions can leverage.
8488

8589
## What's Next?
8690

91+
* [**User Guides**](guides/) - Complete guides to using the marketplace
92+
* [Project Setup](guides/project-setup.md)
93+
* [Feature Development](guides/feature-development.md)
94+
* [Spec-Driven Development](guides/spec-driven-development.md)
95+
* [PR Review](guides/pr-review.md)
96+
8797
### Viewing Available Plugins
8898

8999
List all plugins available in the marketplace:
@@ -110,23 +120,22 @@ Install a specific plugin from the marketplace:
110120

111121
### Learn More About Available Plugins
112122

113-
Explore the [full plugin catalog](plugins/README.md) to find tools that match your workflow.
123+
Explore the [full plugin catalog](plugins/) to find tools that match your workflow.
114124

115125
**Popular plugins to explore next:**
116126

117-
- **[Code Review](plugins/code-review/README.md)** - Multi-agent code review with specialized reviewers (security, bugs, quality, tests)
118-
- **[Git](plugins/git/README.md)** - Streamlined Git workflows, commit creation, PR management
119-
- **[Spec-Driven Development](plugins/sdd/README.md)** - Complete 6-stage workflow from specification to documentation
120-
- **[Test-Driven Development](plugins/tdd/README.md)** - TDD best practices and anti-pattern detection
121-
- **[Kaizen](plugins/kaizen/README.md)** - Root cause analysis using Five Whys, Fishbone diagrams, PDCA cycles
127+
* [**Code Review**](plugins/code-review/) - Multi-agent code review with specialized reviewers (security, bugs, quality, tests)
128+
* [**Git**](plugins/git/) - Streamlined Git workflows, commit creation, PR management
129+
* [**Spec-Driven Development**](plugins/sdd/) - Complete 6-stage workflow from specification to documentation
130+
* [**Test-Driven Development**](plugins/tdd/) - TDD best practices and anti-pattern detection
131+
* [**Kaizen**](plugins/kaizen/) - Root cause analysis using Five Whys, Fishbone diagrams, PDCA cycles
122132

123133
### Understand Core Concepts
124134

125135
Deepen your understanding of how the marketplace works:
126136

127-
- **[User Guide](./user-guide.md)** - Complete guide to using the marketplace
128-
- **[Context Engineering Concepts](./concepts.md)** - Learn about the techniques behind the plugins
129-
- **[Research Papers](./research/)** - Understand the basis for the marketplace plugins
137+
* [**Context Engineering Concepts**](concepts.md) - Learn about the techniques behind the plugins
138+
* [**Research Papers**](research/) - Understand the basis for the marketplace plugins
130139

131140
Welcome to better AI-assisted development with Context Engineering Kit!
132141

docs/guides/README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
# Context Engineering Kit Guides
1+
---
2+
description: >-
3+
Practical how-to guides for getting the most out of the Context Engineering
4+
Kit plugins.
5+
icon: book
6+
---
27

3-
Practical how-to guides for getting the most out of the Context Engineering Kit plugins.
8+
# Guides
49

510
## Workflow Guides
611

7-
| Guide | Description |
8-
|-------|-------------|
9-
| [Feature Development](./feature-development.md) | Complete feature development with reflection and code review quality gates |
10-
| [Spec-Driven Development](./spec-driven-development.md) | Full SDD workflow for complex features requiring planning |
11-
| [Bug Investigation](./bug-investigation.md) | Systematic bug fixing with root cause analysis |
12-
| [Code Quality Improvement](./code-quality-improvement.md) | Systematic quality improvements using Kaizen methodology |
13-
| [Custom Extensions](./custom-extensions.md) | Build project-specific commands and skills |
14-
| [Project Setup](./project-setup.md) | Initialize new projects with best practices |
15-
| [PR Review](./pr-review.md) | Comprehensive pull request review process |
16-
| [Brainstorming to Implementation](./brainstorming-to-implementation.md) | Transform vague ideas into working features |
12+
<table><thead><tr><th width="279">Guide</th><th>Description</th></tr></thead><tbody><tr><td><a href="feature-development.md">Feature Development</a></td><td>Complete feature development with reflection and code review quality gates</td></tr><tr><td><a href="spec-driven-development.md">Spec-Driven Development</a></td><td>Full SDD workflow for complex features requiring planning</td></tr><tr><td><a href="bug-investigation.md">Bug Investigation</a></td><td>Systematic bug fixing with root cause analysis</td></tr><tr><td><a href="code-quality-improvement.md">Code Quality Improvement</a></td><td>Systematic quality improvements using Kaizen methodology</td></tr><tr><td><a href="custom-extensions.md">Custom Extensions</a></td><td>Build project-specific commands and skills</td></tr><tr><td><a href="project-setup.md">Project Setup</a></td><td>Initialize new projects with best practices</td></tr><tr><td><a href="pr-review.md">PR Review</a></td><td>Comprehensive pull request review process</td></tr><tr><td><a href="brainstorming-to-implementation.md">Brainstorming to Implementation</a></td><td>Transform vague ideas into working features</td></tr></tbody></table>
1713

1814
## Quick Reference
1915

2016
### Daily Development
21-
- **New feature**: [Feature Development](./feature-development.md) or [Spec-Driven Development](./spec-driven-development.md) for complex features
22-
- **Bug fix**: [Bug Investigation](./bug-investigation.md)
23-
- **PR review**: [PR Review](./pr-review.md)
17+
18+
* **New feature**: [Feature Development](feature-development.md) or [Spec-Driven Development](spec-driven-development.md) for complex features
19+
* **Bug fix**: [Bug Investigation](bug-investigation.md)
20+
* **PR review**: [PR Review](pr-review.md)
2421

2522
### Improvement Work
26-
- **Refactoring/optimization**: [Code Quality Improvement](./code-quality-improvement.md)
27-
- **Unclear requirements**: [Brainstorming to Implementation](./brainstorming-to-implementation.md)
23+
24+
* **Refactoring/optimization**: [Code Quality Improvement](code-quality-improvement.md)
25+
* **Unclear requirements**: [Brainstorming to Implementation](brainstorming-to-implementation.md)
2826

2927
### Setup Tasks
30-
- **New project**: [Project Setup](./project-setup.md)
31-
- **Team automation**: [Custom Extensions](./custom-extensions.md)
28+
29+
* **New project**: [Project Setup](project-setup.md)
30+
* **Team automation**: [Custom Extensions](custom-extensions.md)

0 commit comments

Comments
 (0)