docbridge 0.10.0 → 0.10.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 +21 -1
- package/dist/bin/darwin-arm64/SHA256SUMS +3 -3
- package/dist/bin/darwin-arm64/docbridge-rust-scanner +0 -0
- package/dist/bin/darwin-arm64/docbridge-swift-scanner +0 -0
- package/dist/bin/darwin-arm64/docbridge_dart_scanner +0 -0
- package/dist/bin/linux-x64/SHA256SUMS +3 -3
- package/dist/bin/linux-x64/docbridge-rust-scanner +0 -0
- package/dist/bin/linux-x64/docbridge-swift-scanner +2 -2
- package/dist/bin/linux-x64/docbridge_dart_scanner +0 -0
- package/dist/index.js +15665 -15626
- package/docs/user/automation.md +2 -2
- package/docs/user/commands.md +4 -4
- package/docs/user/configuration.md +2 -2
- package/docs/user/linking.md +3 -3
- package/docs/user/troubleshooting.md +4 -2
- package/package.json +1 -1
package/docs/user/automation.md
CHANGED
|
@@ -34,8 +34,8 @@ docbridge init-with-agent --agent-target codex
|
|
|
34
34
|
Use `claude` or `both` for the other supported targets. The command installs
|
|
35
35
|
the skill and prints the next command or prompt; it does not launch an agent.
|
|
36
36
|
|
|
37
|
-
<!-- @code src/
|
|
38
|
-
<!-- @code src/
|
|
37
|
+
<!-- @code src/query/context.ts#context -->
|
|
38
|
+
<!-- @code src/query/related.ts#related -->
|
|
39
39
|
|
|
40
40
|
## Editing workflow
|
|
41
41
|
|
package/docs/user/commands.md
CHANGED
|
@@ -13,7 +13,7 @@ Use the narrowest command for the question you need to answer.
|
|
|
13
13
|
The first argument selects a command. Global `--help` and `--version` are
|
|
14
14
|
handled before project scanning, while each command validates its own options.
|
|
15
15
|
|
|
16
|
-
<!-- @code src/
|
|
16
|
+
<!-- @code src/query/check.ts#check -->
|
|
17
17
|
|
|
18
18
|
### `check`: validate the project
|
|
19
19
|
|
|
@@ -22,7 +22,7 @@ annotations, targets, reciprocal links, and the optional link manifest. Add
|
|
|
22
22
|
`--audit` to include warnings for undocumented code declarations and unlinked
|
|
23
23
|
Markdown sections. Add `--json` for machine-readable diagnostics.
|
|
24
24
|
|
|
25
|
-
<!-- @code src/
|
|
25
|
+
<!-- @code src/query/related.ts#related -->
|
|
26
26
|
|
|
27
27
|
### `related`: find counterpart files
|
|
28
28
|
|
|
@@ -36,7 +36,7 @@ git diff --name-only | docbridge related --stdin
|
|
|
36
36
|
set. It identifies review obligations; it does not decide whether the
|
|
37
37
|
counterpart actually needs an edit.
|
|
38
38
|
|
|
39
|
-
<!-- @code src/
|
|
39
|
+
<!-- @code src/query/context.ts#context -->
|
|
40
40
|
|
|
41
41
|
### `context`: read counterpart content
|
|
42
42
|
|
|
@@ -49,7 +49,7 @@ docbridge context src/auth.ts
|
|
|
49
49
|
The default Markdown output is suitable for an agent prompt. `--json` returns
|
|
50
50
|
structured contexts, diagnostics, and a summary.
|
|
51
51
|
|
|
52
|
-
<!-- @code src/
|
|
52
|
+
<!-- @code src/query/graph-output.ts#graph -->
|
|
53
53
|
|
|
54
54
|
### `graph`: inspect link structure
|
|
55
55
|
|
|
@@ -8,7 +8,7 @@ DocBridge loads `docbridge.config.json` from the project root supplied by
|
|
|
8
8
|
`--root`, or from the current directory by default. Paths and glob patterns are
|
|
9
9
|
interpreted relative to that root.
|
|
10
10
|
|
|
11
|
-
<!-- @code src/
|
|
11
|
+
<!-- @code src/config/config.ts#loadConfig -->
|
|
12
12
|
|
|
13
13
|
## Loading configuration
|
|
14
14
|
|
|
@@ -43,7 +43,7 @@ excluded by visibility is not an endpoint; an `@doc` on one is
|
|
|
43
43
|
`unsupported_declaration`. See `docbridge docs show linking` for the
|
|
44
44
|
per-language rules, including Dart's leading-underscore privacy.
|
|
45
45
|
|
|
46
|
-
<!-- @code src/
|
|
46
|
+
<!-- @code src/shared/glob.ts#collectFiles -->
|
|
47
47
|
|
|
48
48
|
## Excluded files
|
|
49
49
|
|
package/docs/user/linking.md
CHANGED
|
@@ -32,7 +32,7 @@ Use `docbridge check --audit` to find unlinked sections and undocumented public
|
|
|
32
32
|
symbols. Audit diagnostics are candidates for judgment, not instructions to
|
|
33
33
|
link every item.
|
|
34
34
|
|
|
35
|
-
<!-- @code src/
|
|
35
|
+
<!-- @code src/model/link-target.ts#parseLinkTarget -->
|
|
36
36
|
|
|
37
37
|
## Target grammar
|
|
38
38
|
|
|
@@ -114,7 +114,7 @@ to include non-`pub` items. Trait definitions and implementations, macros,
|
|
|
114
114
|
constants, statics, unions, and extern blocks are not endpoints. IDs use `::`
|
|
115
115
|
qualification, such as `TypingEngine::advance`.
|
|
116
116
|
|
|
117
|
-
<!-- @code src/
|
|
117
|
+
<!-- @code src/scan/markdown/markdown.ts#scanMarkdown -->
|
|
118
118
|
|
|
119
119
|
## Documentation to code
|
|
120
120
|
|
|
@@ -144,7 +144,7 @@ numeric suffixes.
|
|
|
144
144
|
Each direction is validated independently, so a resolving target can still
|
|
145
145
|
report a missing backlink. Run `docbridge check` after every edit.
|
|
146
146
|
|
|
147
|
-
<!-- @code src/
|
|
147
|
+
<!-- @code src/config/link-manifest.ts#loadLinkManifest -->
|
|
148
148
|
|
|
149
149
|
## Declare links in a manifest
|
|
150
150
|
|
|
@@ -42,8 +42,10 @@ project's own toolchain, then reproduce with the smallest configured file
|
|
|
42
42
|
set.
|
|
43
43
|
|
|
44
44
|
`code_parse_error` means a TypeScript, Swift, Dart, or Rust source file has a
|
|
45
|
-
syntax error.
|
|
46
|
-
|
|
45
|
+
syntax error. The diagnostic points at the first error the language's parser
|
|
46
|
+
found and includes the parser's message. DocBridge extracts no links or symbols
|
|
47
|
+
from that file, so fix the syntax before judging link diagnostics that involve
|
|
48
|
+
it. Unlike
|
|
47
49
|
`code_scanner_failed`, the worker ran correctly; the source itself did not
|
|
48
50
|
parse.
|
|
49
51
|
|