Skip to content

Commit 8acdd6f

Browse files
github-actions[bot]wheels-docs-validator[bot]
andauthored
docs(guides): validate basics directory (run 25501427016) (#2478)
Co-authored-by: wheels-docs-validator[bot] <wheels-docs-validator@users.noreply.github.com>
1 parent 383884d commit 8acdd6f

2 files changed

Lines changed: 208 additions & 2 deletions

File tree

tools/docs-validation/state.json

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7081,6 +7081,212 @@
70817081
"cache_creation_input_tokens": 3323,
70827082
"cache_read_input_tokens": 11742
70837083
}
7084+
},
7085+
"guide:basics/associations.mdx": {
7086+
"kind": "guide",
7087+
"id": "basics/associations.mdx",
7088+
"status": "done",
7089+
"attempts": 1,
7090+
"updatedAt": "2026-05-07T14:19:46.646Z",
7091+
"summary": "Annotated the 2 untested blocks (lines 187 and 201) as illustrative by adding descriptive `title=` attributes. Both are \"before\" comparison examples requiring a running app context (model finders, view loops) and are not independently compilable. All 15 compile-tagged blocks continue to pass the harness (15 passed, 0 failed).",
7092+
"files_changed": [
7093+
"web/sites/guides/src/content/docs/v4-0-0-snapshot/basics/associations.mdx"
7094+
],
7095+
"notes": "2 blocks marked illustrative (title= attribute), 15 compile blocks already passing, 0 prose drift fixes needed.",
7096+
"turns": 5,
7097+
"usage": {
7098+
"input_tokens": 11294,
7099+
"output_tokens": 1099,
7100+
"cache_creation_input_tokens": 9757,
7101+
"cache_read_input_tokens": 18124
7102+
}
7103+
},
7104+
"guide:basics/controllers-and-actions.mdx": {
7105+
"kind": "guide",
7106+
"id": "basics/controllers-and-actions.mdx",
7107+
"status": "done",
7108+
"attempts": 1,
7109+
"updatedAt": "2026-05-07T14:19:57.766Z",
7110+
"summary": "All 10 code blocks on the page were already annotated with `{test:compile}` and pass the harness (10 passed, 0 failed). No changes were needed.",
7111+
"files_changed": [],
7112+
"notes": "10 blocks tested (compile), 0 illustrative, 0 prose drift fixes.",
7113+
"turns": 2,
7114+
"usage": {
7115+
"input_tokens": 1269,
7116+
"output_tokens": 321,
7117+
"cache_creation_input_tokens": 1019,
7118+
"cache_read_input_tokens": 5518
7119+
}
7120+
},
7121+
"guide:basics/database-and-multiple-datasources.mdx": {
7122+
"kind": "guide",
7123+
"id": "basics/database-and-multiple-datasources.mdx",
7124+
"status": "done",
7125+
"attempts": 1,
7126+
"updatedAt": "2026-05-07T14:20:05.908Z",
7127+
"summary": "All 10 code blocks were already annotated with `{test:compile}` and all 10 pass the verify-docs harness. No changes needed.",
7128+
"files_changed": [],
7129+
"notes": "10 tested (compile), 0 illustrative, 0 prose drift fixes.",
7130+
"turns": 2,
7131+
"usage": {
7132+
"input_tokens": 1177,
7133+
"output_tokens": 313,
7134+
"cache_creation_input_tokens": 920,
7135+
"cache_read_input_tokens": 5518
7136+
}
7137+
},
7138+
"guide:basics/forms-and-form-helpers.mdx": {
7139+
"kind": "guide",
7140+
"id": "basics/forms-and-form-helpers.mdx",
7141+
"status": "done",
7142+
"attempts": 1,
7143+
"updatedAt": "2026-05-07T14:20:16.120Z",
7144+
"summary": "All 5 blocks on this page were already correctly annotated: 4 CFML blocks tagged `{test:compile}` (all passing), and 1 HTML rendered-output block marked illustrative. No changes needed; harness reports 4 passed, 0 failed.",
7145+
"files_changed": [],
7146+
"notes": "4 blocks tested (compile), 1 illustrative (HTML rendered output), 0 CFC docblock fixes, 0 prose drift fixes.",
7147+
"turns": 2,
7148+
"usage": {
7149+
"input_tokens": 1018,
7150+
"output_tokens": 392,
7151+
"cache_creation_input_tokens": 810,
7152+
"cache_read_input_tokens": 5518
7153+
}
7154+
},
7155+
"guide:basics/index.mdx": {
7156+
"kind": "guide",
7157+
"id": "basics/index.mdx",
7158+
"status": "done",
7159+
"attempts": 1,
7160+
"updatedAt": "2026-05-07T14:20:19.583Z",
7161+
"summary": "The basics/index.mdx page is a section index with no code blocks. No annotations, prose fixes, or validation steps were needed.",
7162+
"files_changed": [],
7163+
"notes": "0 code blocks total; 0 tested, 0 illustrative, 0 CFC docblock fixes.",
7164+
"turns": 1,
7165+
"usage": {
7166+
"input_tokens": 580,
7167+
"output_tokens": 158,
7168+
"cache_creation_input_tokens": 0,
7169+
"cache_read_input_tokens": 2759
7170+
}
7171+
},
7172+
"guide:basics/migrations.mdx": {
7173+
"kind": "guide",
7174+
"id": "basics/migrations.mdx",
7175+
"status": "done",
7176+
"attempts": 1,
7177+
"updatedAt": "2026-05-07T14:20:35.296Z",
7178+
"summary": "All 10 code blocks on this page were already correctly annotated: 9 tested (1 cli + 8 compile) and 1 illustrative. The verify-docs harness confirmed 9 passed, 0 failed — no changes were needed.",
7179+
"files_changed": [],
7180+
"notes": "9 blocks tested, 1 illustrative (bash block with title=\"your shell\"), 0 CFC docblock fixes, 0 prose drift corrections. Harness output: 9 passed, 0 failed.",
7181+
"turns": 2,
7182+
"usage": {
7183+
"input_tokens": 1152,
7184+
"output_tokens": 369,
7185+
"cache_creation_input_tokens": 912,
7186+
"cache_read_input_tokens": 5518
7187+
}
7188+
},
7189+
"guide:basics/models-and-the-orm.mdx": {
7190+
"kind": "guide",
7191+
"id": "basics/models-and-the-orm.mdx",
7192+
"status": "done",
7193+
"attempts": 1,
7194+
"updatedAt": "2026-05-07T14:20:44.036Z",
7195+
"summary": "All 8 code blocks on this page were already annotated with `{test:compile}` and all 8 pass the verify-docs harness with no failures. No prose drift or docblock fixes were needed.",
7196+
"files_changed": [],
7197+
"notes": "8 blocks tested (compile), 0 illustrative, 0 CFC docblock fixes, 0 prose drift corrections.",
7198+
"turns": 2,
7199+
"usage": {
7200+
"input_tokens": 1112,
7201+
"output_tokens": 330,
7202+
"cache_creation_input_tokens": 861,
7203+
"cache_read_input_tokens": 5518
7204+
}
7205+
},
7206+
"guide:basics/query-builder-and-scopes.mdx": {
7207+
"kind": "guide",
7208+
"id": "basics/query-builder-and-scopes.mdx",
7209+
"status": "done",
7210+
"attempts": 1,
7211+
"updatedAt": "2026-05-07T14:20:52.027Z",
7212+
"summary": "All 11 code blocks on the page were already annotated with `{test:compile}` and all 11 pass the verify-docs harness with no failures. No changes were needed.",
7213+
"files_changed": [],
7214+
"notes": "11 tested (compile), 0 illustrative, 0 CFC docblock fixes, 0 prose drift corrections.",
7215+
"turns": 2,
7216+
"usage": {
7217+
"input_tokens": 1190,
7218+
"output_tokens": 313,
7219+
"cache_creation_input_tokens": 951,
7220+
"cache_read_input_tokens": 5518
7221+
}
7222+
},
7223+
"guide:basics/routing.mdx": {
7224+
"kind": "guide",
7225+
"id": "basics/routing.mdx",
7226+
"status": "done",
7227+
"attempts": 1,
7228+
"updatedAt": "2026-05-07T14:21:02.224Z",
7229+
"summary": "All 7 code blocks on the Routing page were already annotated and tested (6 compile, 1 cli). The harness confirmed 7 passed, 0 failed — no changes needed.",
7230+
"files_changed": [],
7231+
"notes": "Page was fully annotated prior to this run. No prose drift or missing annotations found.",
7232+
"turns": 2,
7233+
"usage": {
7234+
"input_tokens": 1068,
7235+
"output_tokens": 308,
7236+
"cache_creation_input_tokens": 818,
7237+
"cache_read_input_tokens": 5518
7238+
}
7239+
},
7240+
"guide:basics/seeding.mdx": {
7241+
"kind": "guide",
7242+
"id": "basics/seeding.mdx",
7243+
"status": "done",
7244+
"attempts": 1,
7245+
"updatedAt": "2026-05-07T14:21:11.747Z",
7246+
"summary": "All 4 code blocks were already correctly annotated (3 compile, 1 cli). The harness confirms 4 passed, 0 failed — no changes needed.",
7247+
"files_changed": [],
7248+
"notes": "No prose drift or annotation fixes required. Page is fully validated as-is.",
7249+
"turns": 2,
7250+
"usage": {
7251+
"input_tokens": 963,
7252+
"output_tokens": 281,
7253+
"cache_creation_input_tokens": 729,
7254+
"cache_read_input_tokens": 5518
7255+
}
7256+
},
7257+
"guide:basics/validation-and-errors.mdx": {
7258+
"kind": "guide",
7259+
"id": "basics/validation-and-errors.mdx",
7260+
"status": "done",
7261+
"attempts": 1,
7262+
"updatedAt": "2026-05-07T14:21:20.613Z",
7263+
"summary": "All 7 code blocks were already annotated with `{test:compile}` and the harness confirms 7 passed, 0 failed. No changes were needed.",
7264+
"files_changed": [],
7265+
"notes": "No prose drift or untested blocks found. Page is fully validated as-is.",
7266+
"turns": 2,
7267+
"usage": {
7268+
"input_tokens": 1068,
7269+
"output_tokens": 307,
7270+
"cache_creation_input_tokens": 821,
7271+
"cache_read_input_tokens": 5518
7272+
}
7273+
},
7274+
"guide:basics/views-layouts-partials.mdx": {
7275+
"kind": "guide",
7276+
"id": "basics/views-layouts-partials.mdx",
7277+
"status": "done",
7278+
"attempts": 1,
7279+
"updatedAt": "2026-05-07T14:21:29.371Z",
7280+
"summary": "All 6 code blocks were already annotated with `{test:compile}` and passed the harness with no failures. No prose drift or annotation changes were required.",
7281+
"files_changed": [],
7282+
"notes": "6 tested (compile), 0 illustrative, 0 CFC docblock fixes, 0 prose drift fixes.",
7283+
"turns": 2,
7284+
"usage": {
7285+
"input_tokens": 1130,
7286+
"output_tokens": 326,
7287+
"cache_creation_input_tokens": 878,
7288+
"cache_read_input_tokens": 5518
7289+
}
70847290
}
70857291
},
70867292
"runs": []

web/sites/guides/src/content/docs/v4-0-0-snapshot/basics/associations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ component extends="Controller" {
184184

185185
Compare with the non-association form:
186186

187-
```cfm
187+
```cfm title="Illustrative: non-association form (requires running app)"
188188
comment = model("Comment").create(
189189
postId=params.postKey,
190190
author=params.comment.author,
@@ -198,7 +198,7 @@ The first form is shorter, less error-prone (you can't forget the foreign key),
198198

199199
The classic N+1 problem: you load a list of posts, then touch each post's comments inside the view. Each touch fires a new query, and the page crawls.
200200

201-
```cfm
201+
```cfm title="Illustrative: N+1 problem (requires running app)"
202202
posts = model("Post").findAll();
203203
// in the view:
204204
<cfloop query="posts">

0 commit comments

Comments
 (0)