diff --git a/QUICK-REFERENCE.md b/QUICK-REFERENCE.md index da8a1d1..6215e42 100644 --- a/QUICK-REFERENCE.md +++ b/QUICK-REFERENCE.md @@ -23,6 +23,8 @@ The install command always opens a menu. Back at your prompt with no output at a Pick a skill on the dashboard and the same page becomes that session. Details: [.readme/web-console.md](.readme/web-console.md) ยท worked example: [.readme/walkthrough.md](.readme/walkthrough.md). +The **Notepad** icon in the top bar opens a private scratch pad for the folder you are in (Markdown and pictures, kept in `~/.plan2code/notepads/`, never shown to the agent). + ## Commands Every command below is what a dashboard card runs. Typed on its own, each one asks "web console or terminal?" first. diff --git a/README.md b/README.md index a04df33..1fb29b2 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,8 @@ next check-in, and it never holds up your answers. There is more on the page when you need it. Notes on any question can carry screenshots and documents. The folder label in the bottom bar opens your workspace, where you add other folders -as read-only context and point at them by `@name`. The session meter in the top bar turns from green +as read-only context and point at them by `@name`. The **Notepad** in the top bar is a private pad of your own for the +folder, in Markdown with pictures, that the agent never sees. The session meter in the top bar turns from green to red as a session grows long and suggests a fresh one. **Stop session** saves your place and gives you the command to carry on later, and **Back to the dashboard** takes you home to pick the next step in the same session. diff --git a/docs/index.html b/docs/index.html index 1173e95..c4612c2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -335,6 +335,7 @@ footer a { color: inherit; }

Review before you approve

Review the code first, on the sign-off card, reviews exactly the files the phase changed. You tick which findings get fixed, then approve.

The Ask tab

A chat beside the cards for anything you want to know. It is answered at the agent's next check-in and never holds up your answers.

Attachments on notes

Paste a screenshot or attach a document to a note on any question, and show instead of describe.

+

A notepad of your own

A private pad for each project folder, in Markdown with pictures. It never goes into your project, and the agent never sees it.

Workspace folders

Add a shared library or a design folder as read-only context, and point at it by its @name.

Session meter

A ring in the top bar turns from green to red as a session grows long, and suggests when a fresh one would serve you better.

Runs on your machine

A small program Plan2Code starts for you serves the page on 127.0.0.1. No account, no dependencies, and nothing leaves your computer.

@@ -354,6 +355,13 @@ footer a { color: inherit; }
Every ending says what to run next.
+
+ + + The Notepad open over a question: a few lines of Markdown styled as they are typed. + +
Your own notepad, private to the folder.
+
diff --git a/docs/screenshots/ask-dark.webp b/docs/screenshots/ask-dark.webp index f6f6cd5..fdb0ba7 100644 Binary files a/docs/screenshots/ask-dark.webp and b/docs/screenshots/ask-dark.webp differ diff --git a/docs/screenshots/ask-light.webp b/docs/screenshots/ask-light.webp index c97e2b7..bd47088 100644 Binary files a/docs/screenshots/ask-light.webp and b/docs/screenshots/ask-light.webp differ diff --git a/docs/screenshots/build-dark.webp b/docs/screenshots/build-dark.webp index 4a1063d..8d48d86 100644 Binary files a/docs/screenshots/build-dark.webp and b/docs/screenshots/build-dark.webp differ diff --git a/docs/screenshots/build-light.webp b/docs/screenshots/build-light.webp index 7a9490a..857c5d5 100644 Binary files a/docs/screenshots/build-light.webp and b/docs/screenshots/build-light.webp differ diff --git a/docs/screenshots/dashboard-dark.webp b/docs/screenshots/dashboard-dark.webp index 50d97ad..fb5d424 100644 Binary files a/docs/screenshots/dashboard-dark.webp and b/docs/screenshots/dashboard-dark.webp differ diff --git a/docs/screenshots/dashboard-light.webp b/docs/screenshots/dashboard-light.webp index fdaa19c..2389a7a 100644 Binary files a/docs/screenshots/dashboard-light.webp and b/docs/screenshots/dashboard-light.webp differ diff --git a/docs/screenshots/dashboard-utilities-dark.webp b/docs/screenshots/dashboard-utilities-dark.webp index 0c4eb77..073e586 100644 Binary files a/docs/screenshots/dashboard-utilities-dark.webp and b/docs/screenshots/dashboard-utilities-dark.webp differ diff --git a/docs/screenshots/dashboard-utilities-light.webp b/docs/screenshots/dashboard-utilities-light.webp index 5ab6a0e..bb99e60 100644 Binary files a/docs/screenshots/dashboard-utilities-light.webp and b/docs/screenshots/dashboard-utilities-light.webp differ diff --git a/docs/screenshots/doc-dark.webp b/docs/screenshots/doc-dark.webp index 155f442..629ef0b 100644 Binary files a/docs/screenshots/doc-dark.webp and b/docs/screenshots/doc-dark.webp differ diff --git a/docs/screenshots/doc-light.webp b/docs/screenshots/doc-light.webp index e37d61a..0cf1d4a 100644 Binary files a/docs/screenshots/doc-light.webp and b/docs/screenshots/doc-light.webp differ diff --git a/docs/screenshots/finish-dark.webp b/docs/screenshots/finish-dark.webp index 481b273..da4c366 100644 Binary files a/docs/screenshots/finish-dark.webp and b/docs/screenshots/finish-dark.webp differ diff --git a/docs/screenshots/finish-light.webp b/docs/screenshots/finish-light.webp index 9aa274b..83b7420 100644 Binary files a/docs/screenshots/finish-light.webp and b/docs/screenshots/finish-light.webp differ diff --git a/docs/screenshots/git-dark.webp b/docs/screenshots/git-dark.webp index 8d7a6c4..35940fd 100644 Binary files a/docs/screenshots/git-dark.webp and b/docs/screenshots/git-dark.webp differ diff --git a/docs/screenshots/git-light.webp b/docs/screenshots/git-light.webp index 94ff5a3..aab5c17 100644 Binary files a/docs/screenshots/git-light.webp and b/docs/screenshots/git-light.webp differ diff --git a/docs/screenshots/notepad-dark.webp b/docs/screenshots/notepad-dark.webp new file mode 100644 index 0000000..af0c6b2 Binary files /dev/null and b/docs/screenshots/notepad-dark.webp differ diff --git a/docs/screenshots/notepad-light.webp b/docs/screenshots/notepad-light.webp new file mode 100644 index 0000000..886b267 Binary files /dev/null and b/docs/screenshots/notepad-light.webp differ diff --git a/docs/screenshots/question-dark.webp b/docs/screenshots/question-dark.webp index 4b4bbd1..9068d15 100644 Binary files a/docs/screenshots/question-dark.webp and b/docs/screenshots/question-dark.webp differ diff --git a/docs/screenshots/question-light.webp b/docs/screenshots/question-light.webp index d6bd41d..1e9b95f 100644 Binary files a/docs/screenshots/question-light.webp and b/docs/screenshots/question-light.webp differ diff --git a/docs/screenshots/signoff-dark.webp b/docs/screenshots/signoff-dark.webp index 62195db..ae96861 100644 Binary files a/docs/screenshots/signoff-dark.webp and b/docs/screenshots/signoff-dark.webp differ diff --git a/docs/screenshots/signoff-light.webp b/docs/screenshots/signoff-light.webp index d8c42a3..e92530c 100644 Binary files a/docs/screenshots/signoff-light.webp and b/docs/screenshots/signoff-light.webp differ diff --git a/scripts/capture-screenshots.mjs b/scripts/capture-screenshots.mjs index f971c12..479ff84 100644 --- a/scripts/capture-screenshots.mjs +++ b/scripts/capture-screenshots.mjs @@ -81,6 +81,21 @@ const SHOTS = { // The git board draws itself from a real repository, so this shot runs in // its own git sample project; the post only hands the board back to you. git: { workflow: "git", posts: ["git"], repo: true }, + // The Notepad dialog over the plan question, with a few lines of Markdown + // typed into it. The store is the scratch folder's, never the real one. + notepad: { + workflow: "plan", + posts: ["question"], + open: async (page) => { + await page.click("#btn-notepad"); + await page.waitForSelector("#notepad-modal[open]", { timeout: 10000 }); + await page.waitForFunction(() => !document.querySelector("#notepad-modal textarea").readOnly, null, { timeout: 10000 }); + await page.locator("#notepad-modal textarea").fill( + "# Before the call\n\n- Ask about **paging**: cursor or offset?\n- Who signs in to the API?\n- Check the `/tasks` limit with the team\n" + ); + await sleep(1800); + }, + }, }; // --compare only: the screens the docs never show, shot so a change to the @@ -520,7 +535,7 @@ async function main() { SCRATCH = fs.mkdtempSync(path.join(SCRATCH_ROOT, "p2c-shots-")); HOME = path.join(SCRATCH, "console-home"); - ENV = { ...process.env, PLAN2CODE_CONSOLE_HOME: HOME, PLAN2CODE_NO_BROWSER: "1" }; + ENV = { ...process.env, PLAN2CODE_CONSOLE_HOME: HOME, PLAN2CODE_NOTEPADS_DIR: path.join(SCRATCH, "notepads"), PLAN2CODE_NO_BROWSER: "1" }; fs.mkdirSync(HOME, { recursive: true }); fs.mkdirSync(OUT, { recursive: true }); let browser = null;