Skip to content

Commit 9ff3a72

Browse files
committed
docs(design): plan the website template deep-link flow
1 parent 3588f13 commit 9ff3a72

2 files changed

Lines changed: 507 additions & 0 deletions

File tree

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Website template deep-link, version 1
2+
3+
This folder holds the plan for one feature: a visitor clicks "Use this template" on a
4+
template card on the marketing website, lands in the product app, signs up if they need an
5+
account, and the app creates an agent from that template's prompt. This first version is
6+
frontend only. It does not change the backend or any API.
7+
8+
## What each file answers
9+
10+
- `README.md` (this file): what the feature is, the words it uses, and where to start.
11+
- `plan.md`: the whole plan. It describes what a visitor sees today, why the obvious
12+
approach does not work, the four decisions the plan recommends and why, what version 1
13+
builds and what it leaves out, a step-by-step build outline with file paths, and the
14+
tests to write.
15+
16+
Read `plan.md` top to bottom. It is written to be understood without reading the code
17+
first.
18+
19+
## Words this plan uses
20+
21+
A few terms come up throughout. Each one is defined again where it first appears in
22+
`plan.md`; this list is a quick reference.
23+
24+
- **The website**: the marketing site at agenta.ai. It lives in the `website/` folder and
25+
is a separate Astro project, built and deployed on its own, independent of the product
26+
app.
27+
- **The app**: the product at cloud.agenta.ai. It lives in the `web/` folder and is a
28+
Next.js application.
29+
- **Template**: a named starter for an agent. Today a template is mostly a prompt (the
30+
instructions the agent starts with) plus some display text. The app already keeps a list
31+
of 28 of these.
32+
- **Template key**: a short, stable string that names one template, for example
33+
`code-review-agent`. The key is the only piece of information the website hands to the
34+
app.
35+
- **Seed message**: the prompt the app hands to a freshly created agent as its proposed first
36+
message. The app already has one seed message per template. Depending on how the agent was
37+
created, the app either runs the seed on its own or shows it behind a Start button.
38+
- **The invite flow**: the existing feature where a link with a workspace invitation in it
39+
survives a full signup and then routes the new member to the right place. This plan
40+
copies that flow's technique.
41+
- **The agent home page**: the page inside the app that lists a user's agents and shows the
42+
in-app template gallery. Returning users land here.
43+
- **The native onboarding playground**: the first-run experience for a brand-new user. Instead
44+
of the agent home page, a user with no agents yet is sent to a `/playground` route that opens
45+
an empty draft agent. This is on by default, and it is why the plan cannot rely on the agent
46+
home page as the one place every user passes through. The plan covers this in its section
47+
"Where new users actually land, and why it matters"; read that section before the decisions,
48+
because the rest builds on it.
49+
50+
## Status
51+
52+
This is a design proposal. Nothing here is built yet. It is waiting for a review and a
53+
decision on the four questions raised in `plan.md`.

0 commit comments

Comments
 (0)