accessible-menu icon indicating copy to clipboard operation
accessible-menu copied to clipboard

Docs: API documentation is not properly responsive

Open NickDJM opened this issue 3 years ago • 1 comments

Summary

The mobile version of the API docs needs a lot of work. Desktop looks fine, but when you're looking at it on a phone there are multiple elements that don't truly fit on the screen.

Solution

Add custom CSS to fix issues where various elements cause horizontal scroll and other mobile issues.

NickDJM avatar Aug 04 '21 02:08 NickDJM

I've done some looking into this and as much as I liked the idea of having the documentation auto-generated from a time-spent perspective, I don't think the hit the documentation take to usability/readability is worth it.

Perhaps looking into a github pages setup using vuepress or vitepress would be worth while since it looks a hell of a lot better than the auto generated templates. This would be a pretty big undertaking, but I think it would be worth it in the end- possible would need it's own project to maybe reference the bootstrap variants as well. This way documentation updates don't get take a backseat to feature/bug updates.

NickDJM avatar Feb 14 '22 13:02 NickDJM

Vitepress would be a viable option with #199

NickDJM avatar Feb 08 '23 19:02 NickDJM

Updated title and description.

NickDJM avatar Dec 06 '23 14:12 NickDJM