docs: Add Comprehensive Development and UX Documentation #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add new documentation files: - DEVELOPMENT.md: Complete development guide with workflows - TERMINAL_UX.md: Terminal UX improvements documentation - Updated README.md: Professional, concise documentation Documentation improvements: - Clear development workflow instructions - Fixed pnpm run dev (removed auto-restart issue) - Added dev:watch for file watching - Comprehensive testing guide - Terminal compatibility notes - Keybinding reference Package.json changes: - Split dev command: 'dev' (no watch) and 'dev:watch' (with watch) - Better for interactive CLI development
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add comprehensive documentation for development workflow, terminal UX decisions, and improve README to be more professional and concise.
New Documentation
DEVELOPMENT.md
Complete development guide including:
Key Addition: Fixed
pnpm run devauto-restart issue by splitting into separate commands:pnpm run dev- No watch, proper for interactive CLI testingpnpm run dev:watch- Watch mode for when auto-restart is desiredTERMINAL_UX.md
Documents all terminal UX and compatibility decisions:
README.md Improvements
Package.json Changes
{ "scripts": { "dev": "tsx src/index.ts", // Changed: no watch for interactive CLI "dev:watch": "tsx watch src/index.ts" // New: watch mode when needed } }Rationale:
tsx watchauto-restarts on file changes, which breaks interactive CLI testing and makes it impossible to properly quit. Separating these workflows fixes the issue.Benefits
Files Changed
README.md: Professional rewrite, remove decorationsDEVELOPMENT.md: New comprehensive development guideTERMINAL_UX.md: New terminal UX documentationpackage.json: Split dev command into dev and dev:watchTesting Instructions
pnpm run dev- should run once without auto-restartpnpm run dev:watch- should auto-restart on file changesRelated Issues
Fixes the auto-restart issue reported during development and provides complete documentation for the project's terminal-first philosophy.