mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
Address QA review on Quickstart landing page
Two static-review findings from PAP-2514 applied: - Rename to "Quickstart Path" (was "5-Minute Path"). The 5-minute claim with a 15-minute table read as misleading; the title is now honest and the 5-minute promise stays in the body where it can be qualified. - Move installation out of the numbered path. Install is one-time setup; the path proper is now three steps totaling ~5–11 min, which lines up with the body's promise sentence. Drops the misleading "Desktop App is faster if you're not a Node developer" line — Claude Code being a separate prereq breaks that claim. Co-Authored-By: Paperclip <[email protected]>
This commit is contained in:
1 parent
ec0aded498
commit
8464eb7515
2 files changed
+26
-25
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# 5-Minute Path
|
||||
# Quickstart Path
|
||||
|
||||
The shortest route from "downloaded Paperclip" to "an agent has finished a task". You'll install Paperclip, create a company, hire a CEO agent, and approve its first strategy. That's the deal.
|
||||
The shortest route from a running Paperclip instance to an agent that has just completed work for you. After Paperclip is installed, the path takes about 5 minutes: create a company, hire a CEO agent, approve its first strategy, watch tasks land on the board.
|
||||
|
||||

|
||||
|
||||
@@ -10,40 +10,41 @@ The shortest route from "downloaded Paperclip" to "an agent has finished a task"
|
||||
|
||||
A Paperclip company is a self-contained AI organisation — one goal, a team of agents, a task board, a budget. The CEO is the first agent you hire. It reads your goal, proposes a strategy, and — once you approve it — starts creating tasks and moving them across the board.
|
||||
|
||||
You'll see all four ideas (company, agent, task, heartbeat) in the next 15 minutes. The full mental model lives in [Key Concepts](../welcome/key-concepts.md); you don't need it before starting.
|
||||
You'll see all four ideas (company, agent, task, heartbeat) in the next few minutes. The full mental model lives in [Key Concepts](../welcome/key-concepts.md); you don't need it before starting.
|
||||
|
||||
---
|
||||
|
||||
## The path
|
||||
## Before the path: install Paperclip
|
||||
|
||||
Four pages. Allow ~15 minutes total — install is the longest leg and varies with your setup.
|
||||
|
||||
| Step | Page | What you'll have at the end | Approx. time |
|
||||
|------|------|-----------------------------|--------------|
|
||||
| 1 | [Installation](./installation.md) | A running Paperclip instance at `http://localhost:3100` (or your domain) | 3–10 min |
|
||||
| 2 | [Create Your First Company](./your-first-company.md) | A company with a name and a goal | 1–2 min |
|
||||
| 3 | [Hire Your First Agent](./your-first-agent.md) | A configured CEO agent in `idle` status | 2–4 min |
|
||||
| 4 | [Watching Agents Work](./watching-agents-work.md) | A heartbeat fired, a strategy approval submitted, the first tasks on the board | 2–5 min |
|
||||
|
||||
Read the steps in order. They're short on purpose.
|
||||
|
||||
> **Note:** The "5-minute" promise is the time between starting **step 2** and approving the CEO's first strategy in **step 4**. Installation time depends on whether you already have Node.js, Claude Code, and an API key. The Desktop App path is faster if you're not already a Node developer.
|
||||
|
||||
---
|
||||
|
||||
## What you need before you start
|
||||
Install Paperclip and grab an AI provider key. This is one-time setup and lives outside the 5-minute clock — depending on what you already have, expect 3–10 minutes.
|
||||
|
||||
- A Mac (for the Desktop app) or any machine with Node.js 20+ (for the terminal install).
|
||||
- An API key from [Anthropic](https://console.anthropic.com) (for `claude_local`) or [OpenAI](https://platform.openai.com) (for `codex_local`). The installation guide walks through getting one.
|
||||
- For the `claude_local` adapter on Mac: [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed.
|
||||
- For the `claude_local` adapter: [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed on the same Mac. Install this *before* you start the path; you'll need it in step 2.
|
||||
|
||||
> **Warning:** Agents make API calls that cost money. Plan on spending $5–20 to play with the product, $20–100/month for an active company. Set per-agent and company budgets before enabling heartbeats — Paperclip pauses agents automatically when they hit 100%.
|
||||
|
||||
[Walk through Installation →](./installation.md)
|
||||
|
||||
---
|
||||
|
||||
## The 5-minute path
|
||||
|
||||
Three steps after Paperclip is running. Allow ~5–11 minutes total.
|
||||
|
||||
| Step | Page | What you'll have at the end | Approx. time |
|
||||
|------|------|-----------------------------|--------------|
|
||||
| 1 | [Create Your First Company](./your-first-company.md) | A company with a name and a goal | 1–2 min |
|
||||
| 2 | [Hire Your First Agent](./your-first-agent.md) | A configured CEO agent in `idle` status | 2–4 min |
|
||||
| 3 | [Watching Agents Work](./watching-agents-work.md) | A heartbeat fired, a strategy approval submitted, the first tasks on the board | 2–5 min |
|
||||
|
||||
Read the steps in order. They're short on purpose.
|
||||
|
||||
---
|
||||
|
||||
## What you'll see at the end of the path
|
||||
|
||||
By the time you finish step 4, you'll have:
|
||||
By the time you finish step 3, you'll have:
|
||||
|
||||
- A company on the **Companies** page with your goal.
|
||||
- A CEO agent on the **Agents** page in `idle` status with its heartbeat enabled.
|
||||
@@ -57,7 +58,7 @@ That's a working autonomous company. From there, you can hire more agents, refin
|
||||
|
||||
## Where to go next
|
||||
|
||||
Once you finish the four steps:
|
||||
Once you finish the three steps:
|
||||
|
||||
- **Hire your second agent** — the CEO can request reports through the [Approvals](../day-to-day/approvals.md) flow. See [Agents](../org/agents.md) for role design and [Org Structure](../org/org-structure.md) for how reporting lines work.
|
||||
- **Set up real workflows** — read [Issues](../day-to-day/issues.md) for the task lifecycle, [Costs & Budgets](../day-to-day/costs.md) for spend control, and [Heartbeats & Routines](../projects-workflow/routines.md) for scheduling.
|
||||
@@ -65,4 +66,4 @@ Once you finish the four steps:
|
||||
|
||||
If anything in the UI seems unfamiliar along the way, [Key Concepts](../welcome/key-concepts.md) and the [Glossary](../welcome/glossary.md) are the fastest reference.
|
||||
|
||||
[Start with Installation →](./installation.md)
|
||||
[Create Your First Company →](./your-first-company.md)
|
||||
+1
-1
@@ -6,7 +6,7 @@
|
||||
"icon": "rocket",
|
||||
"desc": "Learn what Paperclip is, install it, create your first company, hire an agent, and watch it work.",
|
||||
"pages": [
|
||||
{ "title": "5-Minute Path", "file": "../docs/guides/getting-started/five-minute-path.md" },
|
||||
{ "title": "Quickstart Path", "file": "../docs/guides/getting-started/five-minute-path.md" },
|
||||
{ "title": "What is Paperclip?", "file": "../docs/guides/welcome/what-is-paperclip.md" },
|
||||
{ "title": "Key Concepts", "file": "../docs/guides/welcome/key-concepts.md" },
|
||||
{ "title": "Installation", "file": "../docs/guides/getting-started/installation.md" },
|
||||
|
||||
Reference in new issue
Block a user