Repository navigation
docs: align inline-mentions page with concept-model spec - #116
Merged
Merged
Conversation
The inline-mentions page had drifted from the canonical spec in
concept-model/docs/design/inline-mentions-implementation-guide.md.
This commit realigns it.
src/content/model/inline-mentions.mdx (full rewrite):
- Removed the bogus `urn` kind. URN is a target TYPE, not a kind —
it appears as {{concept:urn:...}} or {{cite:urn:...}}, never as
{{urn:...}}.
- Removed bare `{{designation}}` and `{{112-01-10}}` (no kind). The
spec rejects these at parse time — every mention must have a kind.
- Replaced the "kind = cite looks up sources[] by id" framing with
the spec's resolution algorithm: cite:DATASET:ID resolves the
concept FIRST, then optionally matches a ConceptSource — no
pre-declaration required.
- Added the canonical 8-kind table (concept, cite, fig, table,
formula, bib, link, image) with target types each accepts.
- Added the per-kind target validation table (which kind accepts
which target shape, and what gets rejected).
- Added the structured target parsing table (URN, dataset_qualified,
entity_id, url, path) with the last-colon split rule.
- Replaced the made-up 4-step cascade with the spec's resolution
phases (parse, then resolve) and the deployment routing note.
- Added the common-errors table from the spec.
- Preserved the Data/Deployment Boundary framing (still accurate)
and the deprecated <<ref,title>> migration section.
src/content/docs/software/glossarist-js.mdx:
- Replaced `parseMention()` with `parseMentions()` (plural — returns
segments per spec).
- Removed the invalid `{{urn:...}}` example.
- Updated examples to use realistic DATASET:ID and URN forms.
- Linked to the canonical /model/inline-mentions page.
Build: 105 pages (inline-mentions page now indexed with full
content). Tests: 627 pass (was 624 — content-references test
picked up additional patterns from the rewritten page).
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
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
src/content/model/inline-mentions.mdxwith the canonical spec atconcept-model/docs/design/inline-mentions-implementation-guide.md.src/content/docs/software/glossarist-js.mdxparseMention examples with the same spec.Why this matters
The inline-mentions page had drifted from the spec in several load-bearing ways:
urnkind. The page documented{{urn:URN}}as a kind. The spec has no such kind — URN is a target type, used as{{concept:urn:...}}or{{cite:urn:...}}.{{designation}}and{{112-01-10}}. Spec rejects these at parse time — every mention must carry a kind prefix.citesemantics. Page framedcite:sourceIdas a local lookup insources[]. Spec sayscite:DATASET:IDresolves a concept first, then optionally matches aConceptSource— no pre-declaration required.What changed
src/content/model/inline-mentions.mdx(full rewrite):<<ref,title>>migration sectionsrc/content/docs/software/glossarist-js.mdx:parseMention()(singular) →parseMentions()(plural, returns segments per spec){{urn:...}}exampleDATASET:IDand URN forms/model/inline-mentionsfor the full referenceTest plan
npm test— 627 tests pass (was 624; content-references test picked up additional patterns from the rewritten page)npm run build— 105 pages