liquidsoap
liquidsoap copied to clipboard
improve docs readability
Is your feature request related to a problem? Please describe. online docs are hard to navigate, with summaries not reflecting the titles in core API and extra API.
Additionally, core API has a massive 5000+ lines json that should describe the settings object but is impossible to read (losing track of nesting)
Also extra API has tens (hundreds?) of ffmpeg filters that are also hard to browse as they are not mentioned in the summary and require a lot of scrolling or sometimes guessing
Describe the solution you'd like align the summary with the page content, removing chapters that do not exist, fix broken links and add chapters that do exist but are not included. Ideally with collapsible tree structure it could be easier to navigate h3 items such as ffmpeg filters
if it is necessary to show jsons, do not print them as a regulat text but format them better for example with monospace font and limit to a scrollable textarea/codebox
of course, settings type is not really a json, but i hope the the point is clear
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.