Browse Source

docs: track clonedeps manifest

alvinreal 3 months ago
parent
commit
8c0c31d17c
4 changed files with 21 additions and 20 deletions
  1. 1 1
      docs/skills.md
  2. 4 3
      src/skills/clonedeps/README.md
  3. 13 14
      src/skills/clonedeps/SKILL.md
  4. 3 2
      src/skills/clonedeps/codemap.md

+ 1 - 1
docs/skills.md

@@ -77,7 +77,7 @@ There is intentionally no helper script; dependency discovery and ref validation
 are handled by the orchestrator/librarian workflow so the skill works across
 are handled by the orchestrator/librarian workflow so the skill works across
 languages and repository types.
 languages and repository types.
 
 
-After syncing, the orchestrator also adds or updates a concise
+After cloning, the orchestrator also adds or updates a concise
 `## Cloned Dependency Source` section in root `AGENTS.md`, pointing future agents
 `## Cloned Dependency Source` section in root `AGENTS.md`, pointing future agents
 to `.slim/clonedeps.json` and `.slim/clonedeps/repos/`.
 to `.slim/clonedeps.json` and `.slim/clonedeps/repos/`.
 
 

+ 4 - 3
src/skills/clonedeps/README.md

@@ -13,6 +13,7 @@ and cloning are repo-specific enough that the orchestrator/librarian workflow is
 safer than a brittle cross-ecosystem script.
 safer than a brittle cross-ecosystem script.
 
 
 Cloned repositories live under `.slim/clonedeps/repos/<safe-name>/` and are
 Cloned repositories live under `.slim/clonedeps/repos/<safe-name>/` and are
-ignored by git. After syncing, the orchestrator should add or update a concise
-`## Cloned Dependency Source` section in root `AGENTS.md` pointing future agents
-to `.slim/clonedeps.json` and `.slim/clonedeps/repos/`.
+ignored by git. `.slim/clonedeps.json` is intentionally trackable project
+metadata. After cloning, the orchestrator should add or update a concise
+`## Cloned Dependency Source` section in root `AGENTS.md` that points future
+agents to the JSON manifest and read-only cloned repos.

+ 13 - 14
src/skills/clonedeps/SKILL.md

@@ -139,13 +139,16 @@ Write `.slim/clonedeps.json` so future agents know what exists:
 If a clone fails after earlier clones succeeded, still write state for the
 If a clone fails after earlier clones succeeded, still write state for the
 successful clones so future inspection is not misleading.
 successful clones so future inspection is not misleading.
 
 
+Do not add `.slim/clonedeps.json` to `.gitignore`. It is small, reviewable
+project metadata that can be committed. Only the cloned repository contents
+under `.slim/clonedeps/repos/` should be ignored.
+
 ### Step 5: Update Ignore Files
 ### Step 5: Update Ignore Files
 
 
 Update `.gitignore` with an idempotent marker block:
 Update `.gitignore` with an idempotent marker block:
 
 
 ```gitignore
 ```gitignore
 # BEGIN oh-my-opencode-slim clonedeps
 # BEGIN oh-my-opencode-slim clonedeps
-.slim/clonedeps.json
 .slim/clonedeps/repos/
 .slim/clonedeps/repos/
 # END oh-my-opencode-slim clonedeps
 # END oh-my-opencode-slim clonedeps
 ```
 ```
@@ -178,28 +181,24 @@ section. Otherwise append this section:
 ```markdown
 ```markdown
 ## Cloned Dependency Source
 ## Cloned Dependency Source
 
 
-Selected dependency source repositories are available under
-`.slim/clonedeps/repos/` for local inspection. These clones are ignored by git
-but intentionally unignored for OpenCode visibility. They are local cache and
-may not exist in every checkout.
+Read-only dependency source repositories are available for inspection under
+`.slim/clonedeps/repos/`.
 
 
-If `.slim/clonedeps.json` exists, read it before using the clones; it records
-package names, versions/refs, local paths, and why each dependency was cloned.
+See `.slim/clonedeps.json` for the list of cloned repositories, their refs,
+paths, and why they were added.
 
 
-Use these clones for dependency internals/source inspection. For ordinary API
-usage or current docs, prefer `@librarian`.
+Treat these repositories as read-only reference source. Do not edit them.
 ```
 ```
 
 
-Keep the section concise. Do not paste the full clone plan into `AGENTS.md`;
-the detailed source of truth is `.slim/clonedeps.json`.
+Keep the section concise. Do not paste the full clone plan into `AGENTS.md`; the
+detailed source of truth is `.slim/clonedeps.json`.
 
 
 ## Cleanup
 ## Cleanup
 
 
 When the user asks to clean cloned dependencies, remove:
 When the user asks to clean cloned dependencies, remove:
 
 
 - `.slim/clonedeps/repos/`
 - `.slim/clonedeps/repos/`
-- `.slim/clonedeps.json`
 - the managed clonedeps marker blocks from `.gitignore` and `.ignore`
 - the managed clonedeps marker blocks from `.gitignore` and `.ignore`
 
 
-Ask before removing the `AGENTS.md` section unless the user explicitly requests
-full cleanup.
+Ask before removing `.slim/clonedeps.json` or the `AGENTS.md` section because
+they may be intentional project metadata.

+ 3 - 2
src/skills/clonedeps/codemap.md

@@ -13,8 +13,9 @@ directly.
   orchestrator.
   orchestrator.
 - No helper script is bundled. The skill avoids brittle cross-ecosystem parsing
 - No helper script is bundled. The skill avoids brittle cross-ecosystem parsing
   and keeps repo-specific judgment in librarian/orchestrator.
   and keeps repo-specific judgment in librarian/orchestrator.
-- State is local cache data stored in `.slim/clonedeps.json`; clone contents live
-  under `.slim/clonedeps/repos/<safe-dependency-name>/`.
+- State is trackable project metadata stored in `.slim/clonedeps.json`; clone
+  contents live under `.slim/clonedeps/repos/<safe-dependency-name>/` and are
+  ignored by git.
 - The workflow updates `.gitignore`, `.ignore`, and root `AGENTS.md` with
 - The workflow updates `.gitignore`, `.ignore`, and root `AGENTS.md` with
   concise marker sections so cloned source stays out of git but visible to
   concise marker sections so cloned source stays out of git but visible to
   OpenCode and discoverable by future agents.
   OpenCode and discoverable by future agents.