From 2e2c99b2556e4704bac57df6a797b442adf2d237 Mon Sep 17 00:00:00 2001 From: William Pelrine Date: Wed, 15 Apr 2026 10:23:03 -0700 Subject: [PATCH] feat(night-shift): Link the README cleanly into the docs experience --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29e1394..339422c 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,22 @@ bun add @fuiste/optics ## Documentation -`README.md` remains the primary installation and first-run surface. -Deeper reference material lives in [`docs/README.md`](docs/README.md), which is the canonical docs home consumed by both the repository and the future Pages wrapper. +`README.md` stays responsible for installation and the smallest useful path from zero to composed optics. +Stay here if you need package setup, runtime requirements, or the first example of each optic kind. + +When you need the longer explanation, start at [`docs/README.md`](docs/README.md). +That directory is the canonical docs home for the deeper material: + +- [`docs/quick-start.md`](docs/quick-start.md) for the guided tour after these inline examples +- [`docs/composition.md`](docs/composition.md) and [`docs/combinators.md`](docs/combinators.md) for the result-kind algebra and standard helpers +- [`docs/api-reference.md`](docs/api-reference.md), [`docs/semantics-and-laws.md`](docs/semantics-and-laws.md), and [`docs/best-practices.md`](docs/best-practices.md) for reference material + +Any hosted wrapper, including a future Pages site, should project this same docs corpus rather than fork it into a second manual. ## Quick start +The examples below are the fast path. If you want the same material with more narrative and cross-links, continue with [`docs/quick-start.md`](docs/quick-start.md). + ### Lens (required data) ```typescript