canonical / canonical/multipass.run

URL in section title breaks automatic link

Open
#341 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
5
Forks
25
PR merge metrics
No merged PRs in 30d

Description

We noticed that a section heading `### The netplan.io approach` was rendered incorrectly on the docs website: there was an automatic link for the section heading + an automatic link for the `netplan.io` URL-like part.

We fixed it by adding a backslash: `### The netplan\.io approach`, but this seems like a bug that needs to be addressed.

The affected page is: [How to create an instance](https://multipass.run/docs/create-an-instance?fff)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the affected How to create an instance page and reproduce the issue with the heading `### The netplan.io approach`, comparing it with the escaped version. Trace the documentation heading and automatic-link rendering path, then verify that the heading produces only its section link without a second link around `netplan.io`.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.