docs(site): single-source metrics + MLX command paths; standardize terminology#17
Merged
Merged
Conversation
…rminology
Centralize the figures and CLI invocations that were duplicated across the docs, to stop metric/CLI drift (code-review feedback). A build-time remark plugin (site/src/plugins/remark-metrics.mjs, registered in astro.config.mjs) substitutes {{metric.*}} tokens from src/data/metrics.mjs and {{script.*}} tokens from src/data/scripts.mjs across the narrative pages; an unresolved token fails the build (fail-loud). Rendered output is byte-identical to what users copy-paste, including the column-aligned quickstart block.
Also: standardize the measured (0.914) vs sampled-z (0.934) validity distinction and the "measured-valid CAD" category noun; add DeepCAD-trained scope anchors to time-sensitive claims; fix a typo. Descriptive prose mentions of filenames are intentionally left literal (not duplicated snippets).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Sorry @LayerDynamics, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses code-review feedback on the docs site: repeated metric numbers and MLX command snippets across pages risked drift when numbers or CLIs change. This centralizes both into single sources of truth injected at build time, plus the terminology/scope cleanups the review asked for.
What changed
Single source of truth (new build-time injection)
site/src/data/metrics.mjs— canonical published model numbers.site/src/data/scripts.mjs— canonical MLX trainer script paths.site/src/plugins/remark-metrics.mjs— remark plugin (registered inastro.config.mjs) that substitutes{{metric.<path>}}and{{script.<path>}}tokens on the mdast. Works in prose, inline/fenced code, and MDX JSX string attributes. Fail-loud: an unresolved token failsastro build.Terminology (review comment 2)
0.914(AR) vs sampled-z validity0.934(latent diffusion), and the "measured-valid CAD" category noun.Scope anchors (review comment 3)
Deliberately out of scope
usage.md) are left literal — single contextual descriptions, not duplicated runnable snippets.Verification
astro buildgreen (46 pages, all internal links valid); zero{{metric/{{scripttoken leaks indist/.{{script}}and a{{metric}}token. What users copy-paste is unchanged.🤖 Generated with Claude Code