bunq / doc

The bunq API documentation
https://doc.bunq.com
MIT License
30 stars 19 forks source link

Update Doc to improve usability #75

Closed parrello closed 5 years ago

parrello commented 6 years ago

Doc has been moved to Swagger, but it still needs some work to improve it.

The following is required:

basst85 commented 5 years ago

@parrello The new menu is visible on a desktop, and it looks/works nice 👍🏻

But the menu is not very responsive, on a tablet i get a half menu and on my phone no menu.

parrello commented 5 years ago

@basst85 thanks! I've been working on fixes for the last day and will probably release them today. Right now the menu is not visible by design on a phone, as the bunq update didn't really leave a lot of time for this and as mobile browsing is not the main use case when looking up API docs :)

If you have any suggestion/remark just let me know, as with everything there's always something to improve!

OGKevin commented 5 years ago

and as mobile browsing is not the main use case when looking up API docs :)

you would be surprised xD :p

Nevertheless, the side bar is 👌

parrello commented 5 years ago

@OGKevin interesting. Why do you think it's the case?

OGKevin commented 5 years ago

I know this guy 😂 who likes to use his Ipad Pro as a "second screen" and bc its touchscreen navigating documentation was easier on there and he didn't have to keep switching windows on his MacBook.

But ofc its, not a widely used use case 😁 but seeing that @basst85 brought this up this guy I'm referring to is not the only one.

Ok wait now that I reread your sentence its indeed not the Main use case, but you would be surprised how many actually do use a tablet for docs, that's more what I meant to say.

parrello commented 5 years ago

@OGKevin maybe I was not clear, but my question was limited to browsing from a phone. Tablets (will soon) work fine, and to be fair the iPad pro is almost bigger than my laptop screen, so responsiveness is not an issue there :)