Skip to content
Merged
Changes from all commits
Commits
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
64 changes: 53 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,43 @@
# Forge

Forge automates the software development lifecycle from feature ideation through code delivery using AI-powered planning and execution. It connects Jira, GitHub, and Claude to transform tickets into shipped code with human approval gates at each stage.
Forge automates the software development lifecycle from ticket creation through code delivery using AI-powered planning and execution. It connects Jira, GitHub, and Claude to transform tickets into shipped code with human approval gates at each stage.

Forge supports three distinct, user-facing workflows depending on your ticket type and project requirements.

## How It Works

```mermaid
graph TD
A[Create Feature] --> B[Generate PRD]
B -->|Approval| C[Generate Spec]
C -->|Approval| D[Decompose Epics]
D -->|Approval| E[Generate Tasks]
E -->|Approval| F[Implement Code]
F --> G[Local Review]
G --> H[Create PR]
H --> I[CI/CD + Fix]
I --> J[AI Review]
J --> K[Human Review]
%% Workflow entrypoints
subgraph "1. Choose Your Workflow"
Feature[Jira Feature/Story<br/>Feature Workflow]
Bug[Jira Bug<br/>Bug Workflow]
Task[Jira Task<br/>Task Workflow]
end

%% Workflow processing paths
subgraph "2. Automated Planning & Diagnosis"
PRD[Generate PRD & Spec<br/>with Epic & Task Decomposition]
RCA[Generate Root Cause Analysis<br/>& Option Selection / Fix Plan]
Takeover[Triage & Task Takeover Planning]
end

%% Common implementation & delivery path
subgraph "3. Execution & Delivery"
Code[Autonomous Containerized Implementation]
Review[CI & AI/Human Code Review]
end

%% Connections
Feature --> PRD
Bug --> RCA
Task --> Takeover

PRD --> Code
RCA --> Code
Takeover --> Code

Code --> Review
```

## Quick Links
Expand All @@ -28,6 +50,26 @@ graph TD
- [Skills System](skills/index.md) — Customize Forge for your stack
- [Contributing](dev/contributing.md) — How to contribute

## Supported Workflows

### 🚀 Feature Workflow
Used for long-term or large-scale product changes where requirements need detailed definition and structural design before writing code.
* **Process**: Progresses from initial Jira Feature to automated PRD generation, Technical Spec creation, Epic decomposition, and task implementation with rigorous human review gates at every planning step.
* **When to use**: Choose this workflow for net-new features, substantial architectural modifications, or projects requiring collaborative product/engineering alignment on requirements before any code is touched.
* **More Info**: Read the [Feature Workflow Guide](guide/feature-workflow.md).

### 🐛 Bug Workflow
Designed specifically for triaging, diagnosing, and resolving software defects efficiently.
* **Process**: Forge reproduces the issue inside an isolated sandbox, automatically drafts a detailed Root Cause Analysis (RCA) presenting alternative fix options, generates a concrete fix plan upon option selection, and implements the verified fix.
* **When to use**: Choose this workflow for reported bugs, unexpected crashes, test regressions, or any ticket where the root cause is unknown or multiple fix strategies need to be evaluated first.
* **More Info**: Read the [Bug Workflow Guide](guide/bug-workflow.md).

### 🛠️ Task Workflow
Tailored for already-scoped, standalone tickets or task takeovers that bypass the extended feature planning and decomposition phases.
* **Process**: Forge takes existing, clear engineering instructions directly from a Jira Task or Epic, generates a direct implementation plan, executes the changes in a sandbox, repairs CI, and opens a review-ready Pull Request.
* **When to use**: Choose this workflow for well-defined engineering chores, minor refactors, simple library upgrades, or whenever the technical implementation steps are already pre-determined and agreed upon.
* **More Info**: Read the [Task Workflow Guide](guide/task-workflow.md).

## Key Features

**AI-Powered Planning**
Expand Down
Loading