[Bug] Broken layout after merge of #10855

[bkoelman]

Describe the bug
After #10855 was merged, the API documentation broke across the board. Please revert this refactoring for the time being, so that a .NET 10-compatible version can be released.

Here's one example that broke:

Related source code: https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/4962e9076f2223f48729320778b7a62f385a2e04/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs#L349-L354

Context (please complete the following information):

• OS: Windows
• Docfx version: main at 8b43a7a

Additional context
Add any other context about the problem here.

[filzrev]

It seems occurred when <code> tag is directly adjacent to markdown content.
I've fixed reported issue by PR #10966.

If there are another issues that relating XML comment. Please provide reproduceable samples.

[bkoelman]

@filzrev Thanks, I can confirm that #10966 fixes the original issue. Only vertical spacing has changed a bit because of changes regarding <p> tags, but I'm fine with that.

Here's another case that broke:

Related source code at: https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/ae82a95c24c718e7b21be829320f75fde916fd97/src/JsonApiDotNetCore.Annotations/Resources/Annotations/EagerLoadAttribute.cs

[bkoelman]

Updated the previous message to include before/after.

[filzrev]

Updated the previous message to include before/after.

Is it able to test latest commit of PR #10966?
I've fixed issue that occurred when Doc Comment specific tag (e.g. <example>) exists before <code> tag.
(It need to insert empty line before <code> tag. for markdown to HTML conversion)

[bkoelman]

Tested against the latest commit (057387d), but I'm not seeing any differences (compared to running against the first commit of that PR) in the generated HTML (except for <lastmod> in sitemap.xml), so that commit didn't fix the problem.

[filzrev]

I've updated PR.
Is it able to re-test latest commit of PR #10966?

[bkoelman]

Commit 4 fixes the problem with EagerLoadAttribute, but it also breaks new cases.

For example:

Related source code at: https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/ae82a95c24c718e7b21be829320f75fde916fd97/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs#L176

If you want to test for regressions in our codebase yourself, here are the steps:

1. Clone https://github.com/json-api-dotnet/JsonApiDotNetCore
2. cd docs
3. ./build-dev.ps1 (optionally add -NoOpen to skip opening a browser window once completed)
4. Copy the output of _site to a temporary location to diff against (this is your baseline)
5. Edit the file build-dev.ps1, replacing the line with dotnet exec docfx... to use a local build of docfx. For example:

   -dotnet exec docfx-net10-binaries/docfx.dll -- docfx.json --warningsAsErrors true
   +c:\Sources\docfx\src\docfx\bin\Release\net10.0\docfx.exe docfx.json --warningsAsErrors true

6. Rerun ./build-dev.ps1
7. Diff the output of _site against the baseline

The baseline binaries (docfx-net10-binaries) were produced from https://github.com/json-api-dotnet/docfx/tree/dotnet10-rtm. This branch includes support for .NET 10, but excludes the changes from #10855.

[filzrev]

@bkoelman
Is it able to try latest commit(3b19f12)?

It fixed indent related issues that caused when <pre> tag and markdown text exists on same line.

[bkoelman]

In the latest commit (3b19f12) everything looks good. Thanks for the fixes!