Skip to content

Commit 19263d3

Browse files
authored
docs: comprehensive README restructure with improved demos (#65)
### **User description** ## Summary - Restructured README with clearer hierarchy and improved diff comparison table - Reorganized demo assets to `assets/` and tape files to `scripts/` - Fixed WIP template display in build output (sorted to bottom with "promote to build" hint) - Fixed watch mode event stacking and old entry dimming ## README Changes - **Structure**: Why → Core Idea → Diff Problem → How To Use It - **Diff comparison**: Side-by-side table showing "Without srtd" vs "With srtd" - **Simplified**: Replaced Mermaid diagrams with concise bash examples - **Origin story**: Restored HN links and Timely/Memory Engine references - **Claude Code**: Simplified to single sentence with skill/rule links ## Demo Assets | Before | After | |--------|-------| | `readme-demo.gif` | `assets/demo.gif` | | `readme-workflow-demo.gif` | `assets/workflow-demo.gif` | | `readme-demo.tape` | `scripts/demo.tape` | | `readme-workflow-demo.tape` | `scripts/workflow-demo.tape` | | - | `assets/watch-demo.gif` | | - | `scripts/watch-demo.tape` | | - | `scripts/queue_template_edits.sh` | ## CLI Improvements - WIP templates sorted to bottom in `srtd build` output - Added italic "promote to build" hint for WIP templates - Watch mode: changed→applied events deduplicated - Watch mode: entries >1min now dimmed ## Test plan - [ ] Verify README renders correctly on GitHub - [ ] Verify GIFs display properly - [ ] Run `srtd build` with WIP template to confirm sorting/hint - [ ] Run `srtd watch` to confirm event stacking and dimming 🤖 Generated with [Claude Code](https://claude.com/claude-code) ___ ### **PR Type** Enhancement, Documentation ___ ### **Description** - Restructured README with clearer hierarchy and improved demos - Fixed watch mode event stacking to show only applied actions - WIP templates now sorted to bottom in build output with promotion hint - Old entries (>1min) dimmed in watch mode for better visual hierarchy - Reorganized demo assets to `assets/` and tape files to `scripts/` ___ ### Diagram Walkthrough ```mermaid flowchart LR A["Watch Mode Events"] -->|"changed→applied"| B["Stack Results"] B -->|"Show only applied"| C["Simplified Display"] D["Build Output"] -->|"Sort WIP to bottom"| E["Better Focus"] E -->|"Add promotion hint"| F["Clearer UX"] G["Old Entries >1min"] -->|"Dim in watch"| H["Visual Hierarchy"] I["README"] -->|"Restructure sections"| J["Clearer Navigation"] J -->|"Add diff comparison"| K["Better Documentation"] ``` <details><summary><h3>File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><details><summary>2 files</summary><table> <tr> <td><strong>README.md</strong><dd><code>Comprehensive README restructure with improved organization</code></dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5">+217/-107</a></td> </tr> <tr> <td><strong>watch-demo.tape</strong><dd><code>New watch mode demo with JSON streaming showcase</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-90db588a5156f368100c158d3fed67c73503f0c366a27c01af4e0d0674313112">+53/-0</a>&nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Bug fix</strong></td><td><details><summary>1 files</summary><table> <tr> <td><strong>watch.ts</strong><dd><code>Simplify event stacking to show only applied status</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-0b5cda62a481fa4991723d74b8954950184e8f1425b36173df819200bf9b37e7">+9/-14</a>&nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Enhancement</strong></td><td><details><summary>2 files</summary><table> <tr> <td><strong>resultsTable.ts</strong><dd><code>Add recency-based dimming and WIP promotion hint</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-b23fce913ca18754acf0d504e7e525f525b768495133f6d69ce1b5bb06cf76b7">+38/-12</a>&nbsp; </td> </tr> <tr> <td><strong>queue_template_edits.sh</strong><dd><code>New helper script for queuing template edits</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-03e22570586a286dcd031ec9c473a3e60f88efe437dd09ccc899d3ac51b96827">+33/-0</a>&nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Tests</strong></td><td><details><summary>1 files</summary><table> <tr> <td><strong>watch.test.ts</strong><dd><code>Update tests for simplified event stacking logic</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-38351fd290f501d4098211fdbf95c1be6a3e92aa47063b8e6bbbc7f0b87dd446">+6/-5</a>&nbsp; &nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Configuration changes</strong></td><td><details><summary>2 files</summary><table> <tr> <td><strong>demo.tape</strong><dd><code>Update output path to assets directory</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-033c2e6aeabdbd01f58b3991d6cb6bdee1f072ed2624ee4ed150a66b84327fec">+1/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>workflow-demo.tape</strong><dd><code>Update output path and typing speed for SQL</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-455cedcbc2b2523e83abc096bd31ffaf3f8b9865172abb82b000c93baced4822">+4/-4</a>&nbsp; &nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Miscellaneous</strong></td><td><details><summary>4 files</summary><table> <tr> <td><strong>.srtd.buildlog.json</strong><dd><code>Update build log with new experiment template</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-bda5df27adb782036a76d413c8b895dce469785af067dbd2f9d9cc9a56675cd7">+6/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>.buildlog.local.json</strong><dd><code>Update local build log with experiment entry</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href=""></a></td> </tr> <tr> <td><strong>20251231023252_srtd-srtd_demo_greet.sql</strong><dd><code>New generated migration for greeting function</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-d20b46d430ae653d267c7cfd989d08b6cffad3282c58cf3578fb326392577c13">+24/-0</a>&nbsp; &nbsp; </td> </tr> <tr> <td><strong>20251231023406_srtd-experiment.sql</strong><dd><code>New generated migration for experiment function</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-e169700ca4e34f2dc670b4472618a0b65e4fed5b3fd3c4fb3be8499258eba7bb">+12/-0</a>&nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Additional files</strong></td><td><details><summary>1 files</summary><table> <tr> <td><strong>screenshot.tape</strong></td> <td><a href="https://github.com/t1mmen/srtd/pull/65/files#diff-baf4a16675d927d63b14b3364233c67b3e7ded93e137ae83898599461c141f54">[link]</a>&nbsp; &nbsp; </td> </tr> </table></details></td></tr></tbody></table> </details>
1 parent 7a7eeb8 commit 19263d3

18 files changed

+409
-145
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,4 @@ CLAUDE.md
5656
AGENTS.md
5757
.rules
5858
opencode.json
59-
demo.tape
6059
demo-frames/

0 commit comments

Comments
 (0)