@c4a/context 0.6.0-alpha.1 → 0.6.0-alpha.6
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/docs/getting-started.md
CHANGED
|
@@ -36,8 +36,14 @@ For a Markdown or MDX document corpus, register a file source and keep the
|
|
|
36
36
|
include list inside the user-approved boundary. Default file capture handles
|
|
37
37
|
Markdown. For MDX documentation sites that use `_meta.json` route metadata,
|
|
38
38
|
declare `captureFile({ source: docs, processor: mdxJsonDocs() })` in
|
|
39
|
-
`src/index.ts`; `_meta.json` files are route metadata,
|
|
40
|
-
|
|
39
|
+
`src/index.ts`; `_meta.json` files are route metadata, and the CLI generates
|
|
40
|
+
mechanical evidence pages for route facts and static MDX component text:
|
|
41
|
+
`__context_route_metadata.md` and `__context_mdx_component_text.md`. If the CLI
|
|
42
|
+
reports that a file source looks like a documentation site but lacks the
|
|
43
|
+
processor, confirm the source boundary and add the processor before capture.
|
|
44
|
+
If the selected page is only a runtime shell, capture the rendered-site source
|
|
45
|
+
or project-specific data source explicitly; do not ask the agent to invent
|
|
46
|
+
missing body text. The concrete command shape is available from
|
|
41
47
|
`context source add file --help`; after registration, declare `captureFile`,
|
|
42
48
|
`alignProse`, `compileProse`, and `reviewValidity`.
|
|
43
49
|
|
|
@@ -100,8 +100,19 @@ captureFile({ source: docs, processor: mdxJsonDocs() });
|
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
With that processor, `.md` and `.mdx` are document bodies. Included
|
|
103
|
-
`_meta.json` files are captured as route metadata assets
|
|
104
|
-
`read-plan` / `source-index
|
|
103
|
+
`_meta.json` files are captured as route metadata assets, surfaced in
|
|
104
|
+
`read-plan` / `source-index`, and mechanically projected into
|
|
105
|
+
`__context_route_metadata.md` so route facts can be cited as evidence. The route
|
|
106
|
+
projection records the canonical extensionless route form instead of treating a
|
|
107
|
+
local `.html` URL as the source of truth.
|
|
108
|
+
|
|
109
|
+
MDX component text is extracted separately: string props such as `title`,
|
|
110
|
+
`label`, `description`, `href`, `to`, and component children are projected into
|
|
111
|
+
`__context_mdx_component_text.md` as generated evidence. The original `.mdx`
|
|
112
|
+
file remains in the snapshot unchanged. If a documentation page renders body
|
|
113
|
+
text only at runtime from application code or remote data, configure that
|
|
114
|
+
documentation site as an explicit source boundary instead of hand-writing route
|
|
115
|
+
or body facts.
|
|
105
116
|
|
|
106
117
|
```ts
|
|
107
118
|
captureFile({ source: docs });
|