From e4df70c75e2eccf76ff81020560b8c398e8ba203 Mon Sep 17 00:00:00 2001 From: Kinflou Date: Sun, 1 Nov 2026 01:25:02 +0800 Subject: [PATCH] docs: commit .comline/; the scaffold ignores only fetched dependencies --- docs/docs/getting-started.md | 2 +- docs/docs/guide/packages/index.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index fb1a62f..266ac06 100755 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -44,7 +44,7 @@ my-api/ ├── comline.toml # where generated code goes (all-commented by default) ├── src/ │ └── main.ids # a sample schema -└── .gitignore # ignores .comline/ +└── .gitignore # ignores .comline/deps-cache/ ``` `src/main.ids`: diff --git a/docs/docs/guide/packages/index.md b/docs/docs/guide/packages/index.md index ae257c3..abe2ea4 100644 --- a/docs/docs/guide/packages/index.md +++ b/docs/docs/guide/packages/index.md @@ -82,9 +82,9 @@ After the first `comline build`, a `.comline/` directory holds the (`refs/heads/main`). It is the authoritative, append-only history of the package's versions, and the only copy of it — nothing pushes it anywhere yet. -The `comline new` scaffold git-ignores it, which suits tests and examples. A -package with a version history worth keeping should either commit `.comline/` or, -once [publishing](#publishing-planned) exists, publish it. +Commit it. Nothing publishes it yet, so a clone without it starts over with no +recorded versions. The `comline new` scaffold's `.gitignore` ignores only +`.comline/deps-cache/`, where [git dependencies](#dependencies) are fetched. !!! warning `comline reset` deletes `.comline/` (behind a confirmation). `comline clean`