docfx init
puts external cross reference services under build.xref
instead of build.xrefService
#5053
Labels
xref
Cross reference another document using unique IDs
Operation System: Windows
DocFX Version Used: 2.45
Template used: default
Steps to Reproduce:
Run
docfx init
and answer the question about external API references withhttps://xref.docs.microsoft.com/query?uid={uid}
:Inspect the generated
docfx.json
. Take note of where the cross reference service URL was put.Expected Behavior:
The cross service reference URL
https://xref.docs.microsoft.com/query?uid={uid}
should be put under$.build.xrefService
, as per the documentation.Actual Behavior:
The cross service reference URL is put under
$.build.xref
. This will cause external cross references to be unresolved in generated documentation. I am seeing these warnings during a build:If I manually edit
docfx.json
and rename$.build.xref
to$.build.xrefService
, the warnings disappear and BCL cross references are correctly resolved.The text was updated successfully, but these errors were encountered: