API Docs Visual Refresh
Posted: Fri Nov 04, 2022 12:30 pm
Hello everyone, we’ve been working on a design refresh of the API docs. There were a couple of big and many small problems that we wanted to address to improve readability and usability. The functionality and content stayed mostly the same, this was mainly about presentation. The redesign was also done with an eye towards being a good foundation for the coming prototype docs.
Hopefully, this overhaul improves your experience with the docs. They are still not perfect, of course, so use this thread to bring up any issues you notice, or present any suggestions to further improve the docs. This is explicitly not for issues with the content of the docs, use this thread for that.
Also, we’d especially appreciate feedback on the performance of the website. The previous design had issues with scroll-lag, particularly on less powerful mobile devices. Changes were made to mitigate these, but it’s hard to conclusively test this, so please let us know how the new design performs for you.
Known Issues:
Hopefully, this overhaul improves your experience with the docs. They are still not perfect, of course, so use this thread to bring up any issues you notice, or present any suggestions to further improve the docs. This is explicitly not for issues with the content of the docs, use this thread for that.
Also, we’d especially appreciate feedback on the performance of the website. The previous design had issues with scroll-lag, particularly on less powerful mobile devices. Changes were made to mitigate these, but it’s hard to conclusively test this, so please let us know how the new design performs for you.
Known Issues:
- Layout on mobile does not work well, and cuts off text in many situations.