dotnet / dotnet/docfx

[Bug] `<see>` XML tag ends up as HTML that points to page instead of element on page with corresponding id

Open
#10,322 1 comment 0 reactions 0 assignees View on GitHub
template
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Bug Description & Expected Behavior:**
`` in XML comment resolves to:
`` in yaml which resolves to:
`AcquisitionClockHz` in html instead of:
`AcquisitionClockHz`.

The effect of this is that users are linked to the page instead of the id on page that I want to direct user to.
For example, clicking on this hyperlink [AcquisitionClockHz](https://open-ephys.github.io/bonsai-onix1-docs/api/OpenEphys.Onix1.ContextTask.html) on [this page](https://open-ephys.github.io/bonsai-onix1-docs/api/OpenEphys.Onix1.TS4231V1PositionDataFrame.html) should be [AcquisitionClockHz](https://open-ephys.github.io/bonsai-onix1-docs/api/OpenEphys.Onix1.ContextTask.html#OpenEphys_Onix1_CreateContext_AcquisitionClockHz) instead (compare the underlying URLs - one is appended with a /#mangled_uid). Note that an html element with that particular id "OpenEphys_Onix1_CreateContext_AcquisitionClockHz" doesn't currently exist on the deployed website, but it still doesn't work when I add `id={{id}} data_uid={{uid}}` to an html element which I have done on a local branch.

What are the conditions that create the correct href value where the URL is appended with a \#mangled_uid? This is all done using a custom template, but I'm not sure how that might mess it up.

The repo where I am having this issue is here:
https://github.com/open-ephys/bonsai-onix1-docs

**Context (please complete the following information):**
- Browser: Firefox
- Form factor: desktop
- Docfx version: 2.77.0
- Template: custom

Thank you so much for your help.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.