Documentation site seems very broken

[rahji]

Can you give me a sense of how I might be able to help with fixing the documentation website? Some of the issues I'm seeing:

• None of the couple-dozen links in the "Globals" section at the bottom of the left-side index seem to work
• Pages like https://p5play.org/docs/-_Contro.html and https://p5play.org/docs/-_KeyBoard.html don't seem to have any useful information other than a link to the Learn site. I'd expect to see information about kb or keyboard at the latter link, for example.
• Members don't appear in the index on the left, only Methods (which are confusingly labeled with an F, presumably for "Function")
• The formatting of the pages is very difficult to read. For example, in the Members section of each page, the name of the member seems to be smaller and lighter than the heading "Type:", making it really unreadable unless you're used to the bizarre defaults that JSDoc seems to use.

Does this all come down to JSDoc doing it wrong or being misconfigured? I'd really like to help so my students will have another resource in addition to the Learn website.

Thanks

[quinton-ashley]

My intention is that students and general users should only need to use the Learn reference pages. The more technical Docs pages are just for teachers or contributors.

But yeah unfortunately JSDoc isn't really compatible with modern JavaScript. I had to do a lot of finangling to get those automated docs pages working as well as they are.

I did a little research and even tried implementing other free alternatives but it seems like there aren't any that are better. I did manage to change the theme though because the default jsdoc theme is awful. Although, it still could use some styling work as you noted with the "Type:" text, which could be done in css.

The global links worked before, so idk what happened there, worth investigating.

Currently, Visual Studio Code auto-complete is the best way for users to learn from the technical documentation. https://discord.com/channels/1003099076960723016/1009166111704633464/1150880950792749076

[quinton-ashley]

I would really appreciate any help though!

[quinton-ashley]

fixed!