Back to Fresh

Internal Documentation

docs/internal/README.md

0.3.72.1 KB
Original Source

Internal Documentation

This directory contains design documents, pending work tracking, and architectural decision records for Fresh development.

Key Documents

DocumentDescription
design-decisions.mdUnified audit trail of all major design decisions and trade-offs
docs-audit-0.2.13.mdDocumentation gap analysis for 0.2.9–0.2.13 with validation checklist
markdown.mdMarkdown compose mode remaining work
code-review.mdCode quality improvements to address
refactoring-planning-prompt.mdLLM prompt for producing a refactoring plan in the shape of the existing *-refactor-plan.md docs
buffer-refactor-plan.mdPlan to decompose model/buffer.rs into field-cluster sub-structs (BufferFormat, BufferFileKind, Persistence)
PLAN-git-log-streaming.mdPlan to stream git show into a file-backed buffer (extend spawnProcess with stdoutTo; add lightweight refreshBufferFromDisk); eliminates 43 MB JS string + 1 M-entry FFI marshal on giant commits
PLAN-git-log-diff-folding-and-highlighting.mdPlan for incremental per-file/per-hunk folding (toggleable via standard toggle_fold key) and principled syntect-driven diff highlighting (extend HighlightCategory + theme bg keys; per-chunk through existing lazy-load), scalable to 2 GB diffs

Individual design documents for specific features are preserved alongside the unified summary for deep-dive reference.

User-Facing Documentation

See the parent docs/ directory: