Skip to content

Commit 2997920

Browse files
author
Dominikus Nold
committed
Update to repositioning for brownfield first strategy
1 parent d7362eb commit 2997920

33 files changed

+2979
-316
lines changed

.markdownlint.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD033": false,
5+
"MD041": false
6+
}
7+

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# SpecFact CLI
22

3-
> **Stop "vibe coding", start shipping quality code with contracts**
3+
> **Understand and Modernize Legacy Code with Confidence**
4+
> Automatically extract specs from existing Python code, then enforce them as contracts
45
56
[![License](https://img.shields.io/badge/license-Sustainable%20Use-blue.svg)](LICENSE.md)
67
[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/)
@@ -10,16 +11,16 @@
1011

1112
## What is SpecFact CLI?
1213

13-
A command-line tool that helps you write better code by enforcing **contracts** - rules that catch bugs before they reach production.
14+
A brownfield-first CLI that **reverse engineers your legacy code** into documented specs, then prevents regressions with runtime contract enforcement.
1415

15-
Think of it as a **quality gate** for your development workflow that:
16+
**Perfect for:** Teams modernizing legacy Python systems, data pipelines, DevOps scripts
1617

17-
- ✅ Catches async bugs automatically
18-
- ✅ Validates your code matches your specs
19-
- ✅ Blocks bad code from merging
20-
- ✅ Works offline, no cloud required
18+
**Key capabilities:**
2119

22-
**Perfect for:** Teams who want to ship faster without breaking things.
20+
-**Reverse engineer legacy code** → Extract specs automatically from existing code
21+
-**Runtime contract enforcement** → Prevent regressions during modernization
22+
-**Symbolic execution** → Discover hidden edge cases with CrossHair
23+
-**Works offline** → No cloud required, fully local
2324

2425
---
2526

@@ -38,12 +39,12 @@ pip install specfact-cli
3839
### Your first command (< 60 seconds)
3940

4041
```bash
42+
# Modernizing legacy code? (Recommended)
43+
specfact import from-code --repo . --name my-project
44+
4145
# Starting a new project?
4246
specfact plan init --interactive
4347

44-
# Have existing code?
45-
specfact import from-code --repo . --name my-project
46-
4748
# Using GitHub Spec-Kit?
4849
specfact import from-spec-kit --repo ./my-project --dry-run
4950
```

docs/README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,26 @@
88

99
### New to SpecFact?
1010

11-
**Goal**: Get started in < 5 minutes
11+
**Primary Goal**: Modernize legacy Python codebases in < 5 minutes
1212

1313
1. **[Getting Started](getting-started/README.md)** - Install and run your first command
14-
2. **[See It In Action](examples/dogfooding-specfact-cli.md)** - Real example (< 10 seconds)
15-
3. **[Use Cases](guides/use-cases.md)** - Common scenarios
14+
2. **[Modernizing Legacy Code?](guides/brownfield-engineer.md)****PRIMARY** - Brownfield-first guide
15+
3. **[The Brownfield Journey](guides/brownfield-journey.md)** ⭐ - Complete modernization workflow
16+
4. **[See It In Action](examples/dogfooding-specfact-cli.md)** - Real example (< 10 seconds)
17+
5. **[Use Cases](guides/use-cases.md)** - Common scenarios
1618

17-
**Time**: < 10 minutes | **Result**: Running your first command
19+
**Time**: < 10 minutes | **Result**: Running your first brownfield analysis
1820

1921
---
2022

2123
### Using GitHub Spec-Kit?
2224

23-
**Goal**: Level up from interactive authoring to automated enforcement
25+
**Secondary Goal**: Add automated enforcement to Spec-Kit's interactive authoring
2426

25-
1. **[The Journey: From Spec-Kit to SpecFact](guides/speckit-journey.md)** ⭐ - Complete migration guide
26-
2. **[Migration Use Case](guides/use-cases.md#use-case-1-github-spec-kit-migration)** - Step-by-step
27-
3. **[Bidirectional Sync](guides/use-cases.md#use-case-1-github-spec-kit-migration)** - Keep both tools in sync
27+
1. **[The Journey: From Spec-Kit to SpecFact](guides/speckit-journey.md)** - Add enforcement to Spec-Kit projects
28+
2. **[Spec-Kit Comparison](guides/speckit-comparison.md)** - Understand when to use each tool
29+
3. **[Migration Use Case](guides/use-cases.md#use-case-2-github-spec-kit-migration)** - Step-by-step
30+
4. **[Bidirectional Sync](guides/use-cases.md#use-case-2-github-spec-kit-migration)** - Keep both tools in sync
2831

2932
**Time**: 15-30 minutes | **Result**: Automated enforcement for your Spec-Kit project
3033

@@ -65,8 +68,20 @@
6568

6669
### User Guides
6770

68-
- [Spec-Kit Journey](guides/speckit-journey.md) ⭐ - Migration guide
69-
- [Use Cases](guides/use-cases.md) - Real-world scenarios
71+
#### Primary Use Case: Brownfield Modernization ⭐
72+
73+
- [Brownfield Engineer Guide](guides/brownfield-engineer.md)**PRIMARY** - Complete modernization guide
74+
- [The Brownfield Journey](guides/brownfield-journey.md)**PRIMARY** - Step-by-step workflow
75+
- [Brownfield ROI](guides/brownfield-roi.md) ⭐ - Calculate savings
76+
- [Use Cases](guides/use-cases.md) ⭐ - Real-world scenarios (brownfield primary)
77+
78+
#### Secondary Use Case: Spec-Kit Integration
79+
80+
- [Spec-Kit Journey](guides/speckit-journey.md) - Add enforcement to Spec-Kit projects
81+
- [Spec-Kit Comparison](guides/speckit-comparison.md) - Understand when to use each tool
82+
83+
#### General Guides
84+
7085
- [Workflows](guides/workflows.md) - Common daily workflows
7186
- [IDE Integration](guides/ide-integration.md) - Slash commands
7287
- [CoPilot Mode](guides/copilot-mode.md) - Enhanced prompts

0 commit comments

Comments
 (0)