Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Regression] Links are no longer clickable after update to 2.78.3 #10553

Open
bkoelman opened this issue Feb 21, 2025 · 0 comments
Open

[Regression] Links are no longer clickable after update to 2.78.3 #10553

bkoelman opened this issue Feb 21, 2025 · 0 comments
Labels
dotnet Generate .NET API reference docs

Comments

@bkoelman
Copy link

Describe the bug
Links in v2.78.2 were rendered as clickable links, which is no longer the case after updating to v2.78.3.

Before:

Image

After:

Image

Source code this was produced from:

using JetBrains.Annotations;
using Microsoft.AspNetCore.Mvc.Filters;

namespace JsonApiDotNetCore.Middleware;

/// <summary>
/// Converts action result without parameters into action result with null parameter.
/// <example>
/// <code><![CDATA[
/// return NotFound() -> return NotFound(null)
/// ]]></code>
/// </example>
/// This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
/// https://github.com/dotnet/aspnetcore/issues/16969
/// </summary>
[PublicAPI]
public interface IAsyncConvertEmptyActionResultFilter : IAsyncAlwaysRunResultFilter;

To Reproduce
Steps to reproduce the behavior:

  1. Clone the repo at https://github.com/json-api-dotnet/JsonApiDotNetCore
  2. cd docs
  3. .\build-dev.ps1 -NoBuild
  4. Browser opens, navigate to http://localhost:8080/api/JsonApiDotNetCore.Middleware.IAsyncConvertEmptyActionResultFilter.html
  5. dotnet tool update docfx
  6. Continue from step 3 and observe change in browser

Expected behavior
No change in clickable links.

Context (please complete the following information):

  • OS: Windows

  • Docfx version: 2.78.3

  • .NET version: .NET 9 SDK v9.0.103, runtimes: 8.0.13, 9.0.2

  • docfx.json config

{
  "metadata": [
    {
      "properties": {
        "ProduceReferenceAssembly": "true"
      },
      "src": [
        {
          "files": [
            "**/JsonApiDotNetCore.csproj",
            "**/JsonApiDotNetCore.Annotations.csproj"
          ],
          "src": "../"
        }
      ],
      "dest": "api",
      "disableGitFeatures": false
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md",
          "getting-started/**.md",
          "getting-started/**/toc.yml",
          "usage/**.md",
          "request-examples/**.md",
          "internals/**.md",
          "toc.yml",
          "*.md"
        ],
        "exclude": [
          "**/README.md"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          "diagrams/*.svg"
        ]
      }
    ],
    "overwrite": [
      {
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "dest": "_site",
    "globalMetadataFiles": [],
    "fileMetadataFiles": [],
    "template": [
      "default",
      "modern"
    ],
    "postProcessors": [],
    "noLangKeyword": false,
    "keepFileLink": false,
    "cleanupCacheHistory": false,
    "disableGitFeatures": false
  }
}
  • Exceptions

None

  • Errors and warnings

None

  • .NET info
.NET SDK:
 Version:           9.0.103
 Commit:            96da45d427
 Workload version:  9.0.100-manifests.ea610b94
 MSBuild version:   17.12.24+90b52dda6

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.26100
 OS Platform: Windows
 RID:         win-x64
 Base Path:   C:\Program Files\dotnet\sdk\9.0.103\

.NET workloads installed:
There are no installed workloads to display.
Configured to use loose manifests when installing new manifests.

Host:
  Version:      9.0.2
  Architecture: x64
  Commit:       80aa709f5d

.NET SDKs installed:
  9.0.103 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 9.0.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 9.0.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 8.0.13 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
  Microsoft.WindowsDesktop.App 9.0.2 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
  x86   [C:\Program Files (x86)\dotnet]
    registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables:
  Not set

global.json file:
  Not found

Additional context
None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

1 participant