Skip to content

docs: update README and landing page for LLM-neutral language #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmorris35 merged 1 commit into from
Mar 24, 2026
Merged

docs: update README and landing page for LLM-neutral language #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@

> **The Problem**: AI coding assistants often lose context, skip steps, or produce inconsistent code across sessions.
>
> **The Solution**: DevPlan creates detailed, Haiku-executable development plans with built-in validation, lessons learned, and issue remediation workflows.
> **The Solution**: DevPlan creates detailed, agent-executable development plans with built-in validation, lessons learned, and inline git workflows.

## Key Features

| Feature | Description |
|---------|-------------|
| **Haiku-Executable Plans** | Plans so detailed that Claude Haiku can execute them mechanically |
| **Agent-Executable Plans** | Plans so detailed that any LLM coding agent can execute them mechanically |
| **Built-in Validation** | Validates plans are complete before execution begins |
| **Real-Time Progress Tracking** | Integrates with Claude Code's Task tools for live visibility |
| **Lessons Learned** | Captures issues from verification and injects them into future plans |
Expand Down Expand Up @@ -59,7 +59,7 @@ That's it. DevPlan will guide Claude through the entire process.

## The DevPlan Workflow

DevPlan uses a **scaffold → enhance → validate** workflow that ensures every plan is Haiku-executable before implementation begins.
DevPlan uses a **scaffold → enhance → validate** workflow that ensures every plan is agent-executable before implementation begins.

```mermaid
flowchart LR
Expand All @@ -76,8 +76,8 @@ flowchart LR
end

subgraph Execution["⚡ Execution"]
F --> G[Haiku Executes]
G --> H[Sonnet Verifies]
F --> G[Agent Executes]
G --> H[Agent Verifies]
end

subgraph Learning["🧠 Learning"]
Expand All @@ -94,16 +94,16 @@ flowchart LR

1. **Interview** → DevPlan asks questions to understand your project
2. **Brief** → Creates a structured PROJECT_BRIEF.md with requirements
3. **Generate Scaffold** → `devplan_generate_plan` creates a starting template
4. **Enhance with Code** → Claude (Opus/Sonnet) fills in complete, copy-pasteable code
5. **Validate** → `devplan_validate_plan` checks the plan is Haiku-executable
6. **Execute** → Haiku implements each subtask mechanically
7. **Verify** → Sonnet tries to break the implementation
3. **Generate Scaffold** → `devplan_generate_plan` creates foundation phases + a feature list
4. **Enhance with Code** → Your AI agent structures feature phases and fills in complete, copy-pasteable code
5. **Validate** → `devplan_validate_plan` checks the plan is agent-executable
6. **Execute** → Executor agent implements each subtask with inline git commands
7. **Verify** → Verifier agent tries to break the implementation
8. **Learn** → Issues become lessons for future projects

### Validation Ensures Quality

The validation step checks that plans are truly Haiku-executable:
The validation step checks that plans are truly executable:

- ✅ Complete code blocks (not pseudocode or placeholders)
- ✅ All imports included in code blocks
Expand Down Expand Up @@ -242,14 +242,14 @@ See [docs/ADAPTERS.md](/docs/ADAPTERS.md) for a detailed comparison of each targ
|------|---------|
| `devplan_generate_plan` | Generate DEVELOPMENT_PLAN.md scaffold with validation instructions |
| `devplan_generate_claude_md` | Generate CLAUDE.md scaffold |
| `devplan_generate_executor` | Generate Haiku-powered executor agent with Task tool integration |
| `devplan_generate_verifier` | Generate Sonnet-powered verifier agent with Task tool integration |
| `devplan_generate_executor` | Generate executor agent with Task tool integration |
| `devplan_generate_verifier` | Generate verifier agent with Task tool integration |

### Validation & Execution

| Tool | Purpose |
|------|---------|
| `devplan_validate_plan` | Validate plan structure and Haiku-executability |
| `devplan_validate_plan` | Validate plan structure and agent-executability |
| `devplan_get_subtask` | Get specific subtask details by ID |
| `devplan_update_progress` | Mark subtasks complete with notes |
| `devplan_progress_summary` | Get completion stats and next actions |
Expand Down Expand Up @@ -286,9 +286,9 @@ Convert GitHub issues into structured remediation tasks — perfect for bug fixe
| Without DevPlan | With DevPlan |
|-----------------|--------------|
| Context lost between sessions | Plans preserve full context |
| Inconsistent code quality | Haiku follows exact specifications |
| Inconsistent code quality | Executor agents follow exact specifications |
| Same mistakes repeated | Lessons learned system prevents recurrence |
| No verification step | Sonnet actively tries to break the code |
| No verification step | Verifier agents actively try to break the code |
| Bugs found in production | Issues caught before release |
| Plans need interpretation | Validated plans are copy-paste ready |

Expand Down
26 changes: 13 additions & 13 deletions src/landing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ export function handleLanding(): Response {
<!-- Latest Improvements -->
<div class="max-w-4xl mx-auto px-6 pt-8 pb-2">
<div class="card rounded-lg p-4 border border-blue-500/20 text-sm">
<p class="text-blue-300 font-semibold mb-2">What's New <span class="text-gray-500 font-normal">— Feb 2026</span></p>
<p class="text-blue-300 font-semibold mb-2">What's New <span class="text-gray-500 font-normal">— Mar 2026</span></p>
<ul class="text-gray-400 space-y-1">
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">Full polyglot support</strong> — Plans, agents, and CLAUDE.md now generate with correct tooling for Java, Kotlin, C#, Rust, Go, and more</li>
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">Smarter v2 roadmaps</strong> — Nice-to-have features get clean v2.1, v2.2 numbering under a dedicated roadmap section</li>
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">Language-aware scaffolds</strong> — File paths, test commands, and project structure match your tech stack out of the box</li>
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">Smarter scaffolding</strong> — Foundation phases generated, feature phases left for your agent to structure based on actual project understanding</li>
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">Inline git workflow</strong> — Every subtask includes branch creation, commit commands, and squash merge steps inline</li>
<li><span class="text-green-400 mr-1">+</span> <strong class="text-gray-300">LLM-neutral output</strong> — Plans work with any AI coding agent, not just Claude</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -151,7 +151,7 @@ export function handleLanding(): Response {
<div class="text-center">
<div class="benefit-icon mb-4">⚡</div>
<h3 class="text-xl font-semibold text-white mb-2">Faster Development</h3>
<p class="text-gray-400">Haiku executes plans mechanically while Sonnet verifies. You focus on what matters.</p>
<p class="text-gray-400">Executor agents implement plans mechanically while verifier agents check the work. You focus on what matters.</p>
</div>
<div class="text-center">
<div class="benefit-icon mb-4">🔄</div>
Expand Down Expand Up @@ -199,17 +199,17 @@ export function handleLanding(): Response {
<div class="card rounded-xl p-6 text-center">
<div class="text-3xl font-bold text-purple-400 mb-2">2</div>
<h3 class="font-semibold text-white mb-2">Plan</h3>
<p class="text-gray-400 text-sm">Generates a scaffold, then enhances it with complete code.</p>
<p class="text-gray-400 text-sm">Generates foundation phases and a feature list. Your agent structures the rest.</p>
</div>
<div class="card rounded-xl p-6 text-center">
<div class="text-3xl font-bold text-green-400 mb-2">3</div>
<h3 class="font-semibold text-white mb-2">Validate</h3>
<p class="text-gray-400 text-sm">Checks the plan is complete and ready for mechanical execution.</p>
<p class="text-gray-400 text-sm">Checks the plan is complete, with inline git and ready for execution.</p>
</div>
<div class="card rounded-xl p-6 text-center">
<div class="text-3xl font-bold text-orange-400 mb-2">4</div>
<h3 class="font-semibold text-white mb-2">Execute</h3>
<p class="text-gray-400 text-sm">Haiku implements with live progress tracking. Sonnet verifies. Lessons captured.</p>
<p class="text-gray-400 text-sm">Agent implements with live progress tracking. Verifier checks. Lessons captured.</p>
</div>
</div>
</section>
Expand Down Expand Up @@ -266,25 +266,25 @@ export function handleLanding(): Response {
<form id="testimonial-form" class="max-w-xl mx-auto space-y-6">
<div>
<label for="name" class="block text-sm font-medium text-gray-300 mb-2">Name or Nickname</label>
<input type="text" id="name" name="entry.2051456297" required
<input type="text" id="name" name="entry.47937761" required
class="w-full px-4 py-3 bg-gray-800 border border-gray-700 rounded-lg text-white placeholder-gray-500 focus:border-purple-500 focus:ring-1 focus:ring-purple-500 focus:outline-none transition"
placeholder="Your name, handle, or favorite igneous rock...">
</div>
<div>
<label for="testimonial" class="block text-sm font-medium text-gray-300 mb-2">Your Experience</label>
<textarea id="testimonial" name="entry.1732259482" required rows="4"
<textarea id="testimonial" name="entry.1892905737" required rows="4"
class="w-full px-4 py-3 bg-gray-800 border border-gray-700 rounded-lg text-white placeholder-gray-500 focus:border-purple-500 focus:ring-1 focus:ring-purple-500 focus:outline-none transition resize-none"
placeholder="How has DevPlan helped you? What do you like about it?"></textarea>
</div>
<div>
<label class="block text-sm font-medium text-gray-300 mb-2">May we feature your testimonial on this page?</label>
<div class="flex gap-6">
<label class="flex items-center gap-2 cursor-pointer">
<input type="radio" name="entry.49694324" value="Yes" required class="text-purple-500 focus:ring-purple-500 bg-gray-800 border-gray-700">
<input type="radio" name="entry.345091127" value="Yes" required class="text-purple-500 focus:ring-purple-500 bg-gray-800 border-gray-700">
<span class="text-gray-300">Yes</span>
</label>
<label class="flex items-center gap-2 cursor-pointer">
<input type="radio" name="entry.49694324" value="No" class="text-purple-500 focus:ring-purple-500 bg-gray-800 border-gray-700">
<input type="radio" name="entry.345091127" value="No" class="text-purple-500 focus:ring-purple-500 bg-gray-800 border-gray-700">
<span class="text-gray-300">No</span>
</label>
</div>
Expand All @@ -305,7 +305,7 @@ export function handleLanding(): Response {
e.preventDefault();
const form = e.target;
const formData = new FormData(form);
fetch('https://docs.google.com/forms/d/e/1FAIpQLSdge_JLhEze0nALzv9xnKqEtM9kWOLkN-w-VArwgPGesu08jg/formResponse', {
fetch('https://docs.google.com/forms/d/e/1FAIpQLScRDHW97YywDR4A0iS3xsYR_WlJPfm_gh23LzSLskLQIBFi9A/formResponse', {
method: 'POST',
body: formData,
mode: 'no-cors'
Expand Down
Loading