|
| 1 | +--- |
| 2 | +"@objectstack/spec": patch |
| 3 | +--- |
| 4 | + |
| 5 | +Reference pages no longer print `@example` and `@category` tag lines as literal text. |
| 6 | + |
| 7 | +A module docblock is JSDoc, so its header carries block tags, and the reference-docs |
| 8 | +renderer emitted a tag written on a prose line verbatim — 18 such lines reached 14 |
| 9 | +customer-facing pages, as `@example Basic field mapping` above a code fence and |
| 10 | +`@category Security` at the foot of four `system/` pages. `#13796` removed `@module` |
| 11 | +from the page and left these two open, because a blanket `^@\w+` line filter would |
| 12 | +have taken reader prose off the page and orphaned the fences below it. |
| 13 | + |
| 14 | +The verdict is per tag, and the axis is the payload rather than the spelling: |
| 15 | + |
| 16 | +- **`@example CAPTION` is REWRITTEN** into that caption, in bold, above the block it |
| 17 | + captions — the shape `@see` already had (`See also: …`). 12 lines across 10 pages. |
| 18 | + Bold rather than a heading because heading renumbering has already run by then, so |
| 19 | + an emitted heading would carry a level chosen blind of the page, add entries to the |
| 20 | + pages' tables of contents, and put a caption in reach of `check:docs-single-h1`. |
| 21 | +- **A bare `@example` is DROPPED.** With no payload it is the `@module` case exactly, |
| 22 | + and the fence beneath it is visibly an example without a line announcing one. 2 |
| 23 | + lines (`studio/plugin`, `studio/object-designer`), both sitting against the |
| 24 | + `check:skill-examples` opt-in marker that was already dropped there. |
| 25 | +- **`@category VALUE` is DROPPED.** 4 lines, all reading `Security`, on four pages that |
| 26 | + already sit under a `system/` section saying as much — and nothing in the repo reads |
| 27 | + the tag: no typedoc or api-extractor (neither is used here), no search index, no |
| 28 | + gate. Routing it into page frontmatter instead would publish a field with no |
| 29 | + consumer. The tag stays in the source, where it is a legitimate JSDoc tag; only the |
| 30 | + rendered page drops it. |
| 31 | + |
| 32 | +No schema behavior changes. The pins assert on the rendered fragment rather than on the |
| 33 | +emitted `.mdx`, because `check:docs` compares the artifact against the source and |
| 34 | +reproduced all 18 tag lines faithfully. |
0 commit comments