8000 docs(readme): sales-style README, name section, screenshots and AGENTS.md (#213) by simon-inkie · Pull Request #211 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content

docs(readme): sales-style README, name section, screenshots and AGENTS.md (#213) - #211

Merged
simon-inkie merged 5 commits into
mainfrom
docs/readme-sales-page
Nov 18, 2026
Merged

simon-inkie merged 5 commits into
mainfrom
docs/readme-sales-page

Conversation

@simon-inkie
@simon-inkie simon-inkie commented Nov 18, 2026 •
Copy link
Copy Markdown
Owner

Closes #213.

Rewrites the README opening so it says what Deck is and shows it: four screenshots from fictional demo fixtures (Needs you, an agent thread, the review panel, the project board), a short name section, and a capabilities list limited to what ships. Install and contributing material is unchanged. AGENTS.md becomes a short orientation. SPEC: .specs/213-readme-sales-page/SPEC.md.

Checks on this head: full pnpm test (base 164/164, deck 2415 passed, 11 skipped), typecheck, boundaries, leak gate, licence and dash checks all pass. An independent review found four accuracy issues, all fixed.

…rt AGENTS.md

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
devin-ai-integration[bot]

This comment was marked as resolved.

simon-inkie and others added 3 commits November 18, 2026 21:53
…hs, align CLAUDE.md tagline)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
…er queue)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
@simon-inkie simon-inkie changed the title docs: sales-style README, name section, screenshots and AGENTS.md docs(readme): sales-style README, name section, screenshots and AGENTS.md (#213) Nov 18, 2026
…shots (#213)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
@devin-ai-integration devin-ai-integration Bot left a comment
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 2 new potential issues.

Devin Review

// Some panels poll, so networkidle may never arrive: best effort only.
await page.waitForLoadState("networkidle", { timeout: 8000 }).catch(() => {});
if (s.sidebarPx) {
const box = await page.locator('[role="separator"]').first().boundingBox();
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Project board capture times out

With all shots enabled, sidebarPx makes the project board capture wait for a separator that never renders. Playwright times out before saving the board screenshot.

Learn more

The default capture run includes the project board with sidebarPx: 290. The resize branch queries the first separator, but ReviewPanel renders its separator only when a doc parameter is present. The project route opens without that parameter and does not render thread day dividers. Playwright waits for the missing locator, then throws before reaching the screenshot call.

Example: Run the documented command without SHOTS. The first five images are saved, then the project board capture times out instead of updating its image.

Recommended fix: Do not query a separator for the project-board shot. If sidebar sizing is needed, target the actual sidebar resize control; otherwise remove its sidebarPx setting. For review-panel shots, target the review separator by its accessible label rather than selecting the first separator.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread README.md
Comment on lines +29 to +31
![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 in the same panel with syntax highlighting, so a config file an agent wrote can be read next to the conversation about it.*
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Code-preview caption overstates the linked workflow

The pictured JSON opens via a constructed ?doc=~/attachments/... URL. Clicking the thread's /attachments/...json link opens a new tab, not highlighted code beside the conversation.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

@simon-inkie
simon-inkie merged commit a4cb555 into main Nov 18, 2026
5 checks passed
@simon-inkie
simon-inkie deleted the docs/readme-sales-page branch November 18, 2026 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: sales-style rewrite, name section, screenshots and a short AGENTS.md

1 participant

0