8000 docs(readme): origin wording, Brain mention, decision card image (#234) by simon-inkie · Pull Request #237 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .specs/234-readme-fixes/SPEC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# #234: README fixes

- Issue: https://github.com/simon-inkie/inkie-deck/issues/234
- Branch: `readme-shots-fix`
- Started: 2026-11-19

## TL;DR
Clarify when the agent team and Deck started, introduce the optional Brain
setup, and show an unanswered decision card. Remove the JSON preview screenshot
until #235 lands.

## Scope
- Update README copy and screenshot references, and delete the JSON screenshot.
- No changes to Deck or its setup script.

## Test plan
- Visually check the decision-card PNG against its alt text.
- Run `pnpm check:leaks`, `node scripts/leak-gate.mjs`,
`node packages/deck/scripts/check-dashes.mjs` and `git diff --check`.

## Follow-ups
- Restore the JSON preview screenshot after #235 lands.

## Log

### 2026-11-19: Refresh the README
- What changed: Updated the origin and Brain copy, added the unanswered card
screenshot to the README, and removed the JSON preview screenshot.
- Why: Show the decision before it is answered and explain how to opt in to
memory. The JSON screenshot returns after #235 lands.
- Supersedes: Earlier README origin wording and JSON preview illustration.
- Commits: pending
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Inkie Deck is a local-first control room for your AI agents. Run Claude Code,
Codex and Antigravity side by side, with many more harnesses coming very soon,
and bring every decision and action back to one place, as cards.
With [the Brain](https://github.com/simon-inkie/inkie-the-brain), our open source
long-term memory, your agents [remember across sessions](#give-your-agents-a-memory-that-lasts).

Open source under the [Apache-2.0 licence](LICENSE); [contributions are welcome](CONTRIBUTING.md).

Expand All @@ -26,6 +28,10 @@ needs a choice and an **action card** when it needs you to do something. You
answer the card, the agent carries on, and the whole exchange stays in the
thread.

![Unanswered decision card with two options: launch the spring stationery range this week or wait for the gift-box restock. It also offers a free-text reply, Dismiss and Supersede.](docs/images/decision-card.png)

*The call is yours: pick an option or write your own answer.*

![Agent thread showing an answered decision card, the user's reply and the agent's follow-up](docs/images/agent-thread.png)

*The decision, your answer and the agent's follow-up, kept together.*
Expand All @@ -51,8 +57,8 @@ plugging in any agent that speaks ACP.

## See the work, not a description of it

Agents share what they make as inline images and links to files. Generated
images, code and notes open beside the thread, searchable and ready to review.
Agents share what they make as inline images and links to files. Open their
images, code and notes in the review panel beside the thread.

![A second agent's thread with a launch carousel slide shown inline and links to the kit label and a config file](docs/images/agent-thread-tech.png)

Expand All @@ -62,10 +68,6 @@ images, code and notes open beside the thread, searchable and ready to review.

*Everything an agent produced, open beside the conversation about it.*

![A second agent's thread with an inline carousel slide and a link to its launch config, beside the same config open as highlighted JSON](docs/images/code-preview.png)

*Code opens with syntax highlighting, right next to the thread.*

## Keep the whole team on one board

Every piece of work sits in one of five stages, each card showing its owner and
Expand All @@ -86,9 +88,10 @@ CRM hygiene and code. If an agent can do the work, you can manage it from Deck.

## Built in daily use, not in a lab

Deck began as an internal tool. The first commit went in on 3 June 2026 and it
has run my business every day since, growing a piece at a time as the team
needed it. This is the open source part of that tool, and I now run on this
Deck began as an internal tool: the team of agents behind it has been running
since April 2026, and the app itself, first committed on 3 June 2026, has run my
business every day since, growing a piece at a time as the team needed it.
This is the open source part of that tool, and I now run on this
open source version myself. It looks simple. Underneath it is not, and that is
the point: the complexity is the tool's problem, not yours.

Expand Down Expand Up @@ -143,6 +146,8 @@ git clone https://github.com/simon-inkie/inkie-deck.git && cd inkie-deck
scripts/setup.sh
```

To opt in to the Brain, run `scripts/setup.sh --memory` (requires Node 22 or newer and `jq`).

**On Windows:** Follow the [WSL2 setup notes](INSTALL.md#windows-via-wsl) first.
Keep the clone in your Linux home (for example, `~/inkie-deck`), not on `C:` (`/mnt/c`).

Expand Down
Binary file removed docs/images/code-preview.png
Binary file not shown.
Binary file added docs/images/decision-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
0