julien/typewriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add index READMEs for docs/ and docs/notes/

Browse Source 
Give the two linked-but-unindexed folders a browsable entry point so
directory links land on a real index instead of a bare listing.
This commit is contained in:
Julien Calixte
2026-07-08 14:45:58 +02:00
parent dbe7720a27
commit d6b9e46ec1
2 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/notes/README.md Normal file
View File

@@ -0,0 +1,12 @@
# Notes
> Longer-form essays on the thinking behind specific Typoena choices — the
> arguments too big for an ADR and too durable for a commit message.
>
> Docs index: [`../README.md`](../README.md). Project overview:
> [`../../README.md`](../../README.md).
| Note | What it argues |
| --- | --- |
| [`ctrl-g-perceived-latency.md`](ctrl-g-perceived-latency.md) | Durability before delivery — surfacing "commit landed" at ~0.2 s makes the 5–10 s `Ctrl-G` push feel instant. |
| [`git-sync-images-and-repo-size.md`](git-sync-images-and-repo-size.md) | Why we don't shrink the notes repo — its 153 MB of media is remanso's image CDN, so rewriting history to slim the on-device clone breaks the web app. |