The documentation will be easier to navigate
The GitBook documentation for our projects will be easier to navigate than before. We have made earlier statements about how we’ll schedule changes made to the GitBook docs for all our projects, starting from Nitrocid.
We are using different elements to make our documentation easier to navigate, that is, turning walls of text and long doc pages to expandable sections to make key information stand out and to shorten long pages in a way that makes the docs more comprehensive.
As we are reaching the huge milestone day, the docs will become easier to comprehend, as we are working towards the text flow across docs pages to ensure that all related information stays in one place instead of multiple spots in the same page.
Long sections have been broken down to multiple extendable sections, which can be extended by just clicking on the arrow to get more information. Similarly, multiple release notes have been made easier to read by making use of clear dates and changelogs, colored with the following types of change:
- Green: This color indicates an addition of new features (for example, Added DotBlob screensaver)
- Yellow: This color indicates an improvement or a bug fix (for example, Fixed crashes on startup)
- Red: This color indicates a removal of features (for example, Removed native library dependency)
The changelogs will remain populated on GitHub as proper release markers for quick reference, in case documentation is not available.
Also, cards are used to group different features instead of individual page links to make the experience more welcoming, as well as links at the top of each card and the cover picture to give you a quick glimpse of a feature or an item.
This is a final reminder that the new documentation will get rolled out on February 12th!
#docs #documentation #gitbook #news #Tech #Technology #update
Habr
Aptivi
Aptivi
