From 737be9aa8a5a68ba172be39b9183ee8f4cfc5ff5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Andr=C3=A9?= Date: Sun, 20 Sep 2026 16:21:01 +0200 Subject: [PATCH] Rename model guide --- README.md | 2 +- docs/getting-started.md | 2 +- docs/index.md | 2 +- docs/{model.md => usage.md} | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename docs/{model.md => usage.md} (99%) diff --git a/README.md b/README.md index 9274e61..24b957f 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ output. It only owns the immutable, presentation-neutral data model passed betwe - [Installation](docs/installation.md): install the development package and verify it. - [Getting started](docs/getting-started.md): create a snippet and inspect a selected line. -- [Model](docs/model.md): work with snippets, lines, annotations, segments, and transformations. +- [Usage](docs/usage.md): work with snippets, lines, annotations, segments, and transformations. - [Documentation index](docs/index.md): read the package overview and boundaries. ## Contributing diff --git a/docs/getting-started.md b/docs/getting-started.md index 013f17e..eb50e02 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -38,4 +38,4 @@ index=3 number=26 selected=true `selectLines()` uses one-based positions inside the snippet. Selection marks a line; it does not remove the other lines or define a visual effect. Continue -with the [model](model.md) to annotate, slice, indent, and export snippets. +with the [usage guide](usage.md) to annotate, slice, indent, and export snippets. diff --git a/docs/index.md b/docs/index.md index 7255ffb..0ced9f1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ echo $snippet->lines()[2]->number; // 26 - [Installation](installation.md): install the package and verify it can create a snippet. - [Getting started](getting-started.md): create a snippet and inspect a selected line. -- [Model](model.md): work with snippets, lines, annotations, segments, and transformations. +- [Usage](usage.md): work with snippets, lines, annotations, segments, and transformations. The package owns the portable snippet model. It does not read files, detect languages, locate declarations, tokenize code, or render output. diff --git a/docs/model.md b/docs/usage.md similarity index 99% rename from docs/model.md rename to docs/usage.md index 2e8756f..50dc0bc 100644 --- a/docs/model.md +++ b/docs/usage.md @@ -1,4 +1,4 @@ -# Model +# Usage Code Snippet represents source text and presentation hints with four immutable values. Transformations return a new value, so the original snippet remains