Support cross-references with arg types but no contract prefix
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- handlebars, solidity
- Domain
- documentation
Research direction
Start with the AsciiDoc pipeline and contract.hbs, especially the local :{{fullname}}: attribute mentioned in the issue. Compare how bare references with and without argument types are resolved, then verify that {fn-argtype} links render correctly while existing prefixed and bare forms continue to work.
Written by the indexing model from the issue text.
Description
Following
Issue
Cross-references with arg types but no contract prefix — {fn-argtype} — don't resolve, which forces {Contract-fn-argtype} even for unambiguous self-contract links. The AsciiDoc pipeline already supports the bare form (via contract.hbs's :{{fullname}}: local attribute), so this is a parity gap.
Note: bare {fn} (no arg types) does resolve today — it's specifically the arg-typed prefix-less form that fails.
Sample
Supported ✅
/// @dev Parses [...]. See {ERC4337Utils-packValidationData-address-uint48-uint48}.
Not supported yet ❌ (renders as literal packValidationData-address-uint48-uint48)
/// @dev Parses [...]. See {packValidationData-address-uint48-uint48}.
- Dominant language
- MDX
- Stars
- 6
- Forks
- 23
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 4
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 OpenZeppelin/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenZeppelin/docs#134 · 1 comment ·
-
OpenZeppelin/docs#238 · 1 assignee ·
-
documentation
Difficulty 5/5 Over a week Newbie friendliness 28/100
OpenZeppelin/docs#236 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
OpenZeppelin/docs#199 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
OpenZeppelin/docs#132 ·
All issues in OpenZeppelin/docs
Similar issues
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
GDQuest/learn-gdscript#1395 ·
-
rules
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
HttpClient
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
symfony/symfony-docs#23092 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
huggingface/sentence-transformers#4074 ·