docbridge 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -10
- package/README.md +166 -117
- package/dist/bin/darwin-arm64/SHA256SUMS +2 -2
- package/dist/bin/darwin-arm64/speclink-swift-scanner +0 -0
- package/dist/bin/darwin-arm64/speclink_dart_scanner +0 -0
- package/dist/bin/linux-x64/SHA256SUMS +1 -1
- package/dist/bin/linux-x64/speclink-swift-scanner +0 -0
- package/dist/index.js +891 -14
- package/package.json +1 -1
- package/templates/skills/README.md +10 -6
- package/templates/skills/docbridge-adopt/SKILL.md +23 -5
package/package.json
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
# DocBridge skill templates
|
|
2
2
|
|
|
3
|
-
Distributable agent skills for projects that use DocBridge.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
3
|
+
Distributable agent skills for projects that use DocBridge. Prefer
|
|
4
|
+
`docbridge init` for CLI-driven setup or `docbridge init-with-agent` for
|
|
5
|
+
agent-guided adoption. `init-with-agent` installs `docbridge-adopt` first;
|
|
6
|
+
`docbridge-adopt` installs the companion skills after scope is confirmed.
|
|
7
|
+
Manual copy-based installation remains available: copy a
|
|
8
|
+
skill directory into your repository's skill location (`.claude/skills/` for
|
|
9
|
+
Claude Code or `.agents/skills/` for Codex-style project skills) and adjust
|
|
10
|
+
nothing unless your DocBridge invocation differs from the examples inside.
|
|
8
11
|
|
|
9
12
|
- [`docbridge-annotate`](docbridge-annotate/SKILL.md) — create correct
|
|
10
13
|
`@doc`/`@code` link pairs and verify them with `docbridge check`.
|
|
@@ -13,7 +16,8 @@ from the examples inside.
|
|
|
13
16
|
then update the counterpart or justify leaving it unchanged.
|
|
14
17
|
- [`docbridge-adopt`](docbridge-adopt/SKILL.md) — adopt DocBridge in an existing
|
|
15
18
|
TypeScript, Swift, or Dart project by confirming docs/code scope, creating
|
|
16
|
-
or improving config, and handling simple CI/hook
|
|
19
|
+
or improving config, installing companion skills, and handling simple CI/hook
|
|
20
|
+
setup.
|
|
17
21
|
- [`docbridge-link`](docbridge-link/SKILL.md) — link existing docs sections to
|
|
18
22
|
existing supported code declarations through docs-first candidate discovery
|
|
19
23
|
and section-level confirmation.
|
|
@@ -6,8 +6,9 @@ description: Adopt DocBridge in an existing TypeScript, Swift, or Dart project.
|
|
|
6
6
|
# docbridge-adopt
|
|
7
7
|
|
|
8
8
|
Adopt DocBridge in an existing project. This skill assumes it is already
|
|
9
|
-
installed in the agent environment
|
|
10
|
-
|
|
9
|
+
installed in the agent environment through `docbridge init-with-agent`,
|
|
10
|
+
`docbridge init`, or a manual copy into `.agents/skills/` or
|
|
11
|
+
`.claude/skills/`.
|
|
11
12
|
|
|
12
13
|
The goal is to make the repository ready for DocBridge links, then continue
|
|
13
14
|
into an initial docs-first link-candidate pass. Do not assume a pull request.
|
|
@@ -47,7 +48,24 @@ repo recipe such as `just check`, or
|
|
|
47
48
|
improvement, and edit only after confirmation.
|
|
48
49
|
- Never replace a user-authored config blindly.
|
|
49
50
|
|
|
50
|
-
4. **
|
|
51
|
+
4. **Install companion DocBridge skills.**
|
|
52
|
+
- After scope is confirmed and `docbridge.config.json` exists or has been
|
|
53
|
+
intentionally left unchanged, install the rest of the distributable
|
|
54
|
+
DocBridge skills for the same agent target.
|
|
55
|
+
- Prefer the project-native DocBridge invocation. For example, run
|
|
56
|
+
`docbridge init --yes --agent-target codex`, `docbridge init --yes
|
|
57
|
+
--agent-target claude`, or `docbridge init --yes --agent-target both`
|
|
58
|
+
from the project root. Use the target that matches the existing
|
|
59
|
+
`.agents/` and/or `.claude/` setup.
|
|
60
|
+
- This command should leave an existing `docbridge.config.json` unchanged
|
|
61
|
+
and copy any missing `docbridge-annotate`, `docbridge-link`,
|
|
62
|
+
`docbridge-review`, and `docbridge-sync` skill directories. Do not use
|
|
63
|
+
`--force` unless the user explicitly asks to overwrite installed skills.
|
|
64
|
+
- If the command is unavailable, explain the blocker and provide the manual
|
|
65
|
+
copy target paths from `templates/skills/docbridge-*` instead of silently
|
|
66
|
+
skipping this step.
|
|
67
|
+
|
|
68
|
+
5. **Handle CI/hooks conservatively.**
|
|
51
69
|
- If the existing setup is simple and the user confirmed the mode, implement
|
|
52
70
|
it.
|
|
53
71
|
- If the setup is complex or ambiguous, provide a concrete patch plan or
|
|
@@ -55,11 +73,11 @@ repo recipe such as `just check`, or
|
|
|
55
73
|
- Prefer non-blocking awareness early in adoption unless the user requests a
|
|
56
74
|
hard gate.
|
|
57
75
|
|
|
58
|
-
|
|
76
|
+
6. **Verify the setup.** Run `docbridge check` or the repository's equivalent.
|
|
59
77
|
If the project intentionally has no links yet, a clean zero-link result is
|
|
60
78
|
acceptable. Surface config or scanning diagnostics before proceeding.
|
|
61
79
|
|
|
62
|
-
|
|
80
|
+
7. **Continue into initial candidate discovery.** After setup, inspect the
|
|
63
81
|
confirmed docs scope and present 5-10 high-value section candidates using
|
|
64
82
|
the `docbridge-link` rules. Candidate discovery may continue in the same
|
|
65
83
|
turn, but annotation edits still require section-level user confirmation.
|