docs: comprehensive README restructure with improved demos#65
Conversation
|
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
|||||||||||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #65 +/- ##
==========================================
+ Coverage 80.00% 80.17% +0.16%
==========================================
Files 46 46
Lines 2221 2229 +8
Branches 546 551 +5
==========================================
+ Hits 1777 1787 +10
+ Misses 444 442 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
## README Changes - Restructured with clearer hierarchy: Why → Core Idea → Diff Problem → How To Use It - Added side-by-side diff comparison table (Without srtd vs With srtd) - Replaced ASCII diagrams with concise bash examples - Restored origin story with HN links and Timely/Memory Engine references - Simplified Claude Code integration to single sentence with skill/rule links - Changed H2 sections to H3 for cleaner document outline ## Demo Assets Reorganization - Moved GIFs to assets/ folder (demo.gif, watch-demo.gif, workflow-demo.gif) - Moved tape files to scripts/ folder - Added queue_template_edits.sh helper for watch demo recording - Updated tape output paths to assets/ ## CLI Improvements - WIP templates now sorted to bottom in build output - Added "promote to build" hint for WIP templates in italic - Fixed watch mode event stacking (changed→applied deduplication) - Old entries (>1min) now dimmed in watch output 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
48c1b1b to
768e2ee
Compare
User description
Summary
assets/and tape files toscripts/README Changes
Demo Assets
readme-demo.gifassets/demo.gifreadme-workflow-demo.gifassets/workflow-demo.gifreadme-demo.tapescripts/demo.tapereadme-workflow-demo.tapescripts/workflow-demo.tapeassets/watch-demo.gifscripts/watch-demo.tapescripts/queue_template_edits.shCLI Improvements
srtd buildoutputTest plan
srtd buildwith WIP template to confirm sorting/hintsrtd watchto confirm event stacking and dimming🤖 Generated with 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 toscripts/Diagram Walkthrough
File Walkthrough
2 files
Comprehensive README restructure with improved organizationNew watch mode demo with JSON streaming showcase1 files
Simplify event stacking to show only applied status2 files
Add recency-based dimming and WIP promotion hintNew helper script for queuing template edits1 files
Update tests for simplified event stacking logic2 files
Update output path to assets directoryUpdate output path and typing speed for SQL4 files
Update build log with new experiment templateUpdate local build log with experiment entryNew generated migration for greeting functionNew generated migration for experiment function1 files