search

dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
3.94k stars 839 forks source link

[Bug] Toc filter disappeared on 2.76 version #10011

Open mikasoukhov opened 2 weeks ago

mikasoukhov commented 2 weeks ago

On that configuration https://github.com/StockSharp/doc/blob/main/en/doc.json compiled by 2.75.3 works fine. After migration filtering panel (from left side) - disappeared. Is it a bug or there is need to do some more extra migration steps?

filzrev commented 2 weeks ago

After migration filtering panel (from left side) - disappeared.

Is that mean left side TOC menu area? In this case. that is caused by PR #9737.

As commented on above PR's comment. It introduce BREAKING CHANGE to existing modern template user. (Not included at release note though)

To workaround this issue. It need explicitly set _disableToc: false metadata to related pages. (By using fileMetadata)

mikasoukhov commented 2 weeks ago

To workaround this issue. It need explicitly set _disableToc: false metadata to related pages. (By using fileMetadata)

Thanks. I will wait for the release in where it will be fixed.

filzrev commented 2 weeks ago

Thanks. I will wait for the release in where it will be fixed.

This behavior is intentionally changed. Its purpose is to fix inconsistent TOC visibility behavior between default/modern template.

So without additional Breaking Changes. (I've created [feature request] issue at #10021). Current behavior is expected to continue.

mikasoukhov commented 2 weeks ago

So without additional Breaking Changes. (I've created [feature request] issue at #10021). Current behavior is expected to continue.

I appreciate your detailed explanation regarding the intentional changes to the template behavior. However, I am not fully versed in all the intricacies related to the templates.

Wouldn't it be more efficient to fix the templates themselves to ensure consistent behavior, rather than introducing additional patches to the configuration? Ideally, configurations with default values should remain stable across versions, ensuring seamless updates. This approach would prevent the issue of outdated examples and encourage regular updates without the fear of breaking changes.

Consistency in template behavior without the need for extra configuration adjustments would lead to a more streamlined user experience.

Thank you for considering this perspective.