Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Documentation website redesign #1909
This implements some changes necessary to make the documentation look better with the new jsdoc theme that allows having multiple distinct sections in the website, notably the API Reference separated from the Guides.
To provide a better experience for new developers and to help more experienced developers find the information they need. It also opens up the tutorials to further expansion and better organization.
This separates the pure API Reference from the Tutorials (called Guides here) and the Home page. It should make it easier to find the wanted information without having to scroll a very long single page of information.
Also replaces the
Current PR Issues
The guides sections should be expanded in the future with a more detailed Getting Started section than what is available in the Readme file currently. For now it only makes use of the already available tutorials.
I experimented with a lot of third-party JSDoc themes before deciding to try to modify the existing one since, all of the other ones that fit the bill in terms of having different sections, had some flaws or lacked some features.