Idea detail
showcase_rules
site/reqs/showcase.rq:89
Summary
Four editorial rules. Enforced in content and, where possible, at build time.
See every_rq_block_must_parse, every_showcase_ends_in_a_payoff,
one_worked_example_per_page, diagrams_are_never_dressed_as_code.
Ancestor context
Every language- " rq " block in showcases. ts must parse against the langium grammar. Prefer enforcement via a build step that runs the real parser over content. aligns with [phase_1_parse_gate]
every_showcase_ends_in_a_payoffA diagnostic, a query response, a coverage report, or a graph. If there is no tooling output, it is not a showcase.
one_worked_example_per_pageConsistent identifiers across every block on a page. The reader should trace one name from requirement to source to test to search result without re-orienting.
diagrams_are_never_dressed_as_codeASCII arrow diagrams must not sit inside language- " rq " blocks. They get their own visually distinct block kind. aligns with [showcase_module]
phase_1_parse_gateMake dishonesty impossible. Add a build step that runs the Langium parser over every language- " rq " block in showcases. ts and fails on parse errors or unresolved local refs. Do this first so the rewrite cannot reintroduce the current problem. Also expand Shiki language set per [showcase_languages].
showcase_moduleShowcases are standardised and typed in TS content objects. Short version ( list card ): id, title, summary, tags, mechanism badge. Long version ( detail page ): full blocks array including payoff. Exist as a list page and as a full page per slug. Routes: / showcase / and / showcase / [slug] / — static export. Block kinds needed beyond today's code | features union: callout — the one-sentence point of the page exchange — query + response, terminal-styled diagnostic — editor-style error with quick-fixes diagram — visually distinct from code; never language- " rq " caption / mechanism fields on the showcase object Copy stays minimal and show-don ' t-tell, aligned with site copy rules.
showcase_languages. rq blocks use the custom site tokenizer. Non-. rq blocks need Shiki coverage beyond today's ts / md / py — add st, c, json, yaml for the flagship domains. aligns with [phase_1_parse_gate]
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| references | diagrams_are_never_dressed_as_code | site/reqs/showcase.rq | diagrams_are_never_dressed_as_code |
| references | every_rq_block_must_parse | site/reqs/showcase.rq | every_rq_block_must_parse |
| references | every_showcase_ends_in_a_payoff | site/reqs/showcase.rq | every_showcase_ends_in_a_payoff |
| references | one_worked_example_per_page | site/reqs/showcase.rq | one_worked_example_per_page |
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| None | |||
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| None | |||
Initialising graph…