SDK API Reference inaccessible from Docs
Arlodotexe opened this issue · 4 comments
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
- Strix Music SDK
- Strix Music App
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.
This appears to be the cause: dotnet/docfx#8097.
Looks like we're fully blocked on this for now. See dotnet/docfx#8097 (comment)
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.
Fixed by updating docfx to the latest version.