search

Arlodotexe / strix-music

Combine any music sources into a single library. It's your music. Play it your way.
http://www.strixmusic.com
139 stars 4 forks source link

SDK API Reference inaccessible from Docs #232

Closed Arlodotexe closed 1 year ago

Arlodotexe commented 2 years ago

Describe the bug

The API reference documentation is currently inaccessible. The wrong Table of Contents is showing on the "API" page.

URL: https://strixmusic.com/docs/reference/api/ Snapshot URL: https://ipfs.io/ipfs/QmcGfXPQV42ZwPZEEswEzfnfUmi23bcKLLzUbkWg1Xtqpq/docs/reference/api/

Affected area

Regression

No response

Steps to reproduce

Go to the links provided above. Try to access the generated API docs.

Visual repro steps

No response

Expected behavior

API reference should be accessible.

Additional context

No response

Help us help you

Yes, I'd like to be assigned to work on this item.

Arlodotexe commented 2 years ago

This appears to be the cause: https://github.com/dotnet/docfx/issues/8097.

Arlodotexe commented 2 years ago

Looks like we're fully blocked on this for now. See https://github.com/dotnet/docfx/issues/8097#issuecomment-1234775306

Arlodotexe commented 1 year ago

Coming back to this 4 months later, I'm able to generate documentation locally, so there may be hope for fixing this in CI. If done after a git clean -xdf, it also generates API reference docs correctly.

Otherwise, it'll sometimes show an error but still complete, and the generated website will have the same problem as the snapshot in the original post.

Arlodotexe commented 1 year ago

Fixed by updating docfx to the latest version.