dotnet / dotnet/docfx

[Bug] Broken layout after merge of #10855

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

Description

**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:

Image

Image

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 8b43a7ab7719a93cbd2c73e7d629a079042949bb

**Additional context**
Add any other context about the problem here.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the refactoring merged in #10855 and the related BaseJsonApiController.cs source link, then reproduce the broken API documentation layout with the stated Docfx revision. Identify the affected change and restore the pre-#10855 behavior; done means the documented layout works again and a .NET 10-compatible release can proceed.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.