oxidecomputer / oxidecomputer/typify
Feature Request: URL handling in documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 898
- Forks
- 114
- Avg merge
- 4h 18m
- Merged PRs (30d)
- 14
Description
Super niche issue, but I ran into this while parsing the MCP schema.
warning: this URL is not a hyperlink
--> .../target/debug/build/mcp-58ca0a9bf43df898/out/schema.rs:3319:1
|
3319 | https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1*/
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: bare URLs are not automatically turned into clickable links
help: use an automatic link instead
|
3319 | <https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1>*/
relevant schema line: https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.json#L1061
This could end up overly complex if "does this description contain a URL" is harder than one would expect, but it would be nice to wrap urls in <> when encountered to avoid the doc bug and produce better docs.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start at schema/2024-11-05/schema.json#L1061 and trace how that description is emitted into target/.../out/schema.rs:3319. Identify the URL-handling point in the generator, then verify that generated Rust documentation wraps encountered URLs in angle brackets and no longer produces the bare-URL warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100