Skip to content

Commit f1a023e

Browse files
committed
docs: add README generation section to build and deployment spec
Add comprehensive README.md generation specification including required sections (title, philosophy, features, quick start, configuration, workflow, shortcuts, development, license), style rules, and update the features table description to mention README generation.
1 parent 0b4e2af commit f1a023e

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

specs2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A complete specification for an **AI-assisted code editing tool** that runs as a
5858
| [Search Interface](search_interface.md) | Full-text search UI |
5959
| [Settings Interface](settings_interface.md) | Config editing UI |
6060
| [Speech to Text](speech_to_text.md) | Voice dictation via Web Speech API |
61-
| [Build and Deployment](build_and_deployment.md) | Build pipeline, versioning, startup |
61+
| [Build and Deployment](build_and_deployment.md) | Build pipeline, versioning, startup, README generation |
6262

6363
## Core Concepts
6464

specs2/build_and_deployment.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,33 @@ A per-repository working directory at `{repo_root}/.ac-dc/`. Created on first ru
353353

354354
This directory is **not** committed to the repository. The `.gitignore` entry is created automatically on first use.
355355

356+
## README.md Generation
357+
358+
The repository root contains a `README.md` that serves as a combined user guide and developer reference. Keep it as a single file with these sections in order:
359+
360+
1. **Title & tagline** — project name with lightning bolt, one-sentence description
361+
2. **Philosophy** — speed-over-agency stance and the hybrid workflow (sprint → hit wall → agent → return)
362+
3. **Features** — one bullet per capability, one sentence each, no elaboration
363+
4. **Quick Start** — platform binaries from releases, `chmod`, run from git repo
364+
5. **Configuration** — two subsections:
365+
- LLM config with provider examples (Anthropic, OpenAI, Ollama, OpenAI-compatible local, Bedrock, Azure, Vertex) as copy-pasteable JSON blocks, plus a field reference table
366+
- App config with defaults table
367+
6. **Workflow** — numbered steps from task description through commit
368+
7. **Keyboard Shortcuts** — table reflecting actual implementations:
369+
- `chat-input.js` `_onKeyDown`: Enter, Shift+Enter, Escape, ↑ at start, ↓ at end
370+
- `diff-viewer.js` `_onKeyDown`: Ctrl/Cmd+S, Ctrl/Cmd+W
371+
- `ac-dialog.js` `KEYBOARD_SHORTCUTS` + `_onGlobalKeyDown`: Alt+1..5, Alt+M
372+
- When shortcuts change in code, update the table to match
373+
8. **Development** — prerequisites, setup, run modes table, CLI options table, test commands, tech stack with library links, project structure tree with one-line file descriptions
374+
9. **License** — MIT
375+
376+
### Style rules
377+
378+
- One sentence per feature bullet — no multi-paragraph explanations
379+
- Tables for all reference data (config fields, CLI options, shortcuts)
380+
- Project structure tree must mirror actual file layout — update on file add/remove/rename
381+
- No screenshots, videos, or embedded media in the markdown
382+
356383
## Graceful Degradation
357384

358385
| Failure | Behavior |

0 commit comments

Comments
 (0)