Skip to content

Commit ae1121b

Browse files
Add "Get Started with Ref Plans" doc page (#10)
* Add Getting Started with Ref Plans doc page - Create plans/getting-started/get-started.mdx with full walkthrough - Uses Mintlify Steps, Cards, Frames, Note, Tip components - Includes placeholder screenshot references for later - Add page to docs.json navigation under Plans > Getting Started Co-Authored-By: Matt Dailey <matt@ref.tools> * Consolidate quick-start into get-started guide and reorganize agent setup documentation * Rename "Get Started" guide to "Your First Plan" and streamline content * Simplify getting started guide and update image references --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Matt Dailey <matt@ref.tools> Co-authored-by: Matt Dailey <matthew.j.dailey@gmail.com>
1 parent b9d3822 commit ae1121b

13 files changed

Lines changed: 170 additions & 51 deletions

docs.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
"group": "Getting Started",
120120
"pages": [
121121
"plans/getting-started/intro",
122-
"plans/getting-started/quick-start",
122+
"plans/getting-started/your-first-plan",
123123
"plans/getting-started/best-practices"
124124
]
125125
},
@@ -284,6 +284,8 @@
284284
{ "source": "/examples/case-studies", "destination": "/context/getting-started/intro" },
285285
{ "source": "/examples/multi-repo", "destination": "/context/getting-started/intro" },
286286
{ "source": "/examples/vibe-code-sleep-training", "destination": "/context/getting-started/intro" },
287-
{ "source": "/plans/beta", "destination": "/plans/getting-started/intro" }
287+
{ "source": "/plans/beta", "destination": "/plans/getting-started/intro" },
288+
{ "source": "/plans/getting-started/quick-start", "destination": "/plans/getting-started/your-first-plan" },
289+
{ "source": "/plans/getting-started/get-started", "destination": "/plans/getting-started/your-first-plan" }
288290
]
289291
}
510 KB
Loading
715 KB
Loading
589 KB
Loading
701 KB
Loading

images/your-first/ref5-comment.png

1.1 MB
Loading
597 KB
Loading
1.34 MB
Loading

index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Search public and private documentation from any MCP-compatible coding agent.
1212
## Ref Plans
1313
Write, iterate, and collaborate on plans for coding agents. Orchestrate agents to implement them.
1414

15-
<Card icon="circle-info" title="Intro to Ref Plans" href="/plans/getting-started/intro">Overview of what Ref Plans is and how it works.</Card>
16-
<Card icon="rocket" title="Quick Start" href="/plans/getting-started/quick-start">Create your first plan and send it to an agent.</Card>
15+
<Card icon="circle-info" title="Overview" href="/plans/getting-started/intro">Overview of what Ref Plans is and how it works.</Card>
16+
<Card icon="rocket" title="Get Started" href="/plans/getting-started/your-first-plan">Create your first plan and send it to an agent.</Card>

plans/getting-started/intro.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Intro to Ref Plans"
2+
title: "Overview"
33
description: "Ref Plans in one page."
44
---
55

@@ -30,8 +30,8 @@ Instead of ephemeral chat sessions that disappear when you close a tab, Plans gi
3030
- **Web-based and mobile-friendly** — Start a plan on your laptop, review it on your phone, launch agents from anywhere.
3131

3232
<Columns cols={2}>
33-
<Card icon="rocket" title="Quick Start" href="/plans/getting-started/quick-start">
34-
Create your first plan in minutes.
33+
<Card icon="rocket" title="Get Started" href="/plans/getting-started/your-first-plan">
34+
Create your first plan and send it to an agent.
3535
</Card>
3636
<Card icon="trophy" title="Best Practices" href="/plans/getting-started/best-practices">
3737
How to write plans that get great results.

0 commit comments

Comments
 (0)