Render: link and code-span attribute types, and use internal links more generally
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 62/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- go
- Domain
- documentation
Research direction
Start in markdown.go:309 at typeCell, then inspect the heading and anchor handling used for rendered Markdown; mermaid.go:104-108 explains why attributes are omitted from Mermaid output. Compare the generated files in docs/05-parking-garage/ and examples/ with their goldens. Done means type references use stable internal links and code spans consistently, with tests pinning the anchor scheme and updated goldens.
Written by the indexing model from the issue text.
Description
Found while reviewing #37 (renderer hardening). Not a bug and not a security issue — #37 closes the escaping hole, so a hostile type string is already rendered as text. This is about the Markdown being more useful to read.
The concrete case: attributes[].type
attributes[].type renders in exactly one place: the Markdown attribute table's Type column, markdown.go:309 via typeCell. The Mermaid ER never sees it — it deliberately omits attributes, since freeform conceptual types like enum[active, archived] aren't valid erDiagram attribute types (mermaid.go:104-108).
typeCell has two branches: a scope.Name whose scope is a bound import becomes a link; everything else falls through to mdCell as plain prose. So the same column renders three ways:
| `holderName` | string |
| `status` | AccountStatus |
| `paidWith` | [payments.PaymentMethod](./payments.modelith.md#paymentmethod) |
Two things are worth changing.
A local enum type isn't linked, but a cross-model one is. That is backwards from what a reader expects. In docs/05-parking-garage/garage.modelith.md, AccountStatus is defined 30 lines above under ### + backticked name, which already generates the anchor #accountstatus. Nothing uses it:
$ grep -c '](#' docs/05-parking-garage/garage.modelith.md
0
The document has anchors and no internal links to them. Meanwhile a type pointing at another file gets a working link.
The type is the only identifier the renderer doesn't code-span. Attribute names, enum value names, action names, actor names, import scopes and paths all go through codeSpan. The enum's own definition heading is code-spanned. The type cell referencing that enum is bare, so one table row has a code-spanned name sitting next to a bare type.
Target:
| `status` | [`AccountStatus`](#accountstatus) |
| `paidWith` | [`payments.PaymentMethod`](./payments.modelith.md#paymentmethod) |
A code span nests inside a link label in GFM, so both cases can render consistently rather than diverging.
The broader theme
The rendered Markdown has more anchors than it uses. Other candidates, roughly in order of how obviously useful they are:
- A relationship's
entity:— link to that entity's section. - An action's
preserves:and a scenario'sinvariants_touched:— link to the invariant they name. These are already id references the linter resolves, so the target is known to be valid. - Backticked entity and glossary terms in prose —
lintalready resolves these for its backticked-term check, so the renderer could link what the linter already matched. This one is the largest and most likely to look noisy; worth prototyping before committing.
The principle: where the linter already resolves a reference, the renderer usually knows enough to link it.
Notes for whoever picks this up
- Do it when
typeCellis already open. Cross-model imports slice 2 (vendoring, ADR-0010) touches that function for vendored-model links; folding this in there avoids churning the goldens twice. - Goldens will churn across every attribute row in
examples/anddocs/05-parking-garage/. - Anchor generation depends on the renderer's heading format, so a test should pin the anchor scheme rather than assuming GitHub's slugging stays put.
- Deliberately kept out of #37, which is a security fix — a presentation change riding along would have made that diff harder to review.
🤖 Filed by Claude Code
- Dominant language
- Go
- Stars
- 32
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stacklok/modelith
-
enhancement
Difficulty 2/5 Half a day Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 28/100
-
documentation
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
All issues in stacklok/modelith
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·