mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 04:45:33 -08:00
Rebuild the marketing page around the desktop app on a blueprint look (the app tilted over one light, a four-step session in the hero, the loop ledger, stacked install), add a Plan-suggested dashboard screenshot for it, and list Git as a prerequisite in every newcomer doc since npm needs it to fetch the installer
AI Assisted
This commit is contained in:
1 parent
1d064b18f3
commit
567a65ff5b
10 files changed
+827
-927
No files matched your search
@@ -10,6 +10,7 @@ Each session stays short, and the specs on disk carry everything from one sessio
|
||||
## Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Git.** Check with `git --version`. The installer is fetched from GitHub with Git, and without it npm stops with `spawn git ENOENT`. No Git? Get it from [git-scm.com](https://git-scm.com/downloads), or run `winget install Git.Git` on Windows, `brew install git` on macOS, or use your package manager on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first, or let the `plan2code` command's setup page walk you through it.
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
## Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Git.** Check with `git --version`. The installer is fetched from GitHub with Git, and without it npm stops with `spawn git ENOENT`. No Git? Get it from [git-scm.com](https://git-scm.com/downloads), or run `winget install Git.Git` on Windows, `brew install git` on macOS, or use your package manager on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first, or let the `plan2code` command's setup page walk you through it.
|
||||
|
||||
@@ -33,6 +33,7 @@ The dashboard, in a project halfway through a build. It suggests the next step f
|
||||
### Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Git.** Check with `git --version`. The installer is fetched from GitHub with Git, and without it npm stops with `spawn git ENOENT`. No Git? Get it from [git-scm.com](https://git-scm.com/downloads), or run `winget install Git.Git` on Windows, `brew install git` on macOS, or use your package manager on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first, or let the `plan2code` command's setup page walk you through it.
|
||||
|
||||
+792
-924
File diff suppressed because it is too large.
Load diff
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
@@ -13,7 +13,7 @@
|
||||
// The shots use the console's Ocean highlight rather than its default orange:
|
||||
// it is the console's nearest to the Plan2Code blue the site and README use.
|
||||
//
|
||||
// Shots: dashboard, dashboard-utilities, question, doc, build, signoff, finish, ask, git.
|
||||
// Shots: dashboard, dashboard-plan, dashboard-utilities, question, doc, build, signoff, finish, ask, git.
|
||||
// --compare adds workspace, stop, delete, help, prefs and cleanup: screens the
|
||||
// docs never show, for checking a change by eye against a "before" set. Its
|
||||
// --out must be outside docs/screenshots/, so the set is never published.
|
||||
@@ -64,6 +64,15 @@ const SHOTS = {
|
||||
scrollTo: ".dash-toggle",
|
||||
mustShow: ".dash-card:has(.pill.suggested)",
|
||||
},
|
||||
// The same dashboard in a project with no specs yet, where Plan is the
|
||||
// suggested card: the landing page's first step, before the questions.
|
||||
"dashboard-plan": {
|
||||
workflow: "dashboard",
|
||||
posts: ["dashboard-plan"],
|
||||
fresh: true,
|
||||
scrollTo: ".dash-toggle",
|
||||
mustShow: ".dash-card:has(.pill.suggested)",
|
||||
},
|
||||
// The utility cards sit even lower: scroll until the Git card is the
|
||||
// last row in frame ("cmd:" picks a card by its command).
|
||||
"dashboard-utilities": {
|
||||
@@ -285,6 +294,15 @@ function makeSampleProject() {
|
||||
return project;
|
||||
}
|
||||
|
||||
// The dashboard-plan shot's project: the same name and AGENTS.md, nothing
|
||||
// planned yet. It sits in its own folder so both can be called task-api.
|
||||
function makeFreshProject() {
|
||||
const project = path.join(SCRATCH, "fresh", "task-api");
|
||||
fs.mkdirSync(project, { recursive: true });
|
||||
fs.copyFileSync(path.join(SCRATCH, "task-api", "AGENTS.md"), path.join(project, "AGENTS.md"));
|
||||
return project;
|
||||
}
|
||||
|
||||
// The Workspace shot's second folder, beside the sample project.
|
||||
function makeExtraFolder() {
|
||||
const dir = path.join(SCRATCH, "task-web");
|
||||
@@ -580,7 +598,7 @@ async function main() {
|
||||
args: ["--no-first-run", "--no-default-browser-check", "--mute-audio"],
|
||||
});
|
||||
for (const name of names) {
|
||||
const where = table[name].repo ? makeGitProject() : project;
|
||||
const where = table[name].repo ? makeGitProject() : table[name].fresh ? makeFreshProject() : project;
|
||||
const { sid, url } = stage(where, table[name]);
|
||||
try {
|
||||
if (table[name].ask) await captureAsk(browser, where, sid, url, table[name].ask);
|
||||
|
||||
@@ -8,6 +8,7 @@ and dark WebP images in `docs/screenshots/`.
|
||||
| File | Stages |
|
||||
| --- | --- |
|
||||
| `dashboard.json` | The dashboard menu, suggesting the next build phase |
|
||||
| `dashboard-plan.json` | The dashboard in a project with no specs yet, suggesting Plan (the script builds that project) |
|
||||
| `question.json` | A Plan session with three questions open (also the base of the Ask shot) |
|
||||
| `doc.json` | A living document with settled, assumed and draft sections, and its review card |
|
||||
| `build.json` | A phase being built: the progress bar, the task list and the current task |
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"menu": {
|
||||
"note": "Nothing is planned in task-api yet. Plan is the place to start.",
|
||||
"recommend": "plan2code-1-plan"
|
||||
},
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -31,7 +31,8 @@ function blockOf(file) {
|
||||
for (const file of DOCS) {
|
||||
test(`${file} tells a newcomer how to get started`, () => {
|
||||
const block = blockOf(file);
|
||||
for (const needle of ['Node.js 18', 'node --version', 'nodejs.org', '/plan2code', '$plan2code']) {
|
||||
// Git is a prerequisite too: npm fetches the installer with it (git+https).
|
||||
for (const needle of ['Node.js 18', 'node --version', 'nodejs.org', 'git --version', 'git-scm.com', '/plan2code', '$plan2code']) {
|
||||
assert.ok(block.includes(needle), `${file} is missing "${needle}" in its "Before you start" block`);
|
||||
}
|
||||
assert.match(block, /project you want to (work on|work in)/, `${file} does not say to start from your project`);
|
||||
|
||||
Reference in new issue
Block a user