Here’s your sneak peek of the improved docs design!
As we’ve stated earlier in one of the last articles about the improved docs design plan, our plan was to make the documentation visually appealing to make the docs more gorgeous and more understandable to a wider audience.
Today, we have finally made the updated, improved documentation design available in the main Aptivi docs page! We have changed the design from simplistic to appealing design, and we’ve made the text less wordy to make the docs more understandable.
This is the current state now, versus the previous design:
We have used cards instead of bullet points with links to give you a comprehensive list of projects and other elements without introducing walls of text. Cover photos are also used to make those cards stand out, ensuring visual appearance. Links will also appear in the titles, if desired, along with a slightly bigger text due to space.
For step-by-step instructions and other listings, we have replaced the traditional bullet points and walls of text with elements like “steppers” and “expandables.” This is to ensure easier comprehension when following the steps while hiding secondary content under expandables. Restructuring the pages is also done to make sure that all key points are in one place instead of different points that point to the same section but scattered to multiple places.
The above image also shows a role of expandables when it comes to addressing different points when sections aren’t enough, such as code of conduct and contribution guidelines.
We are very excited to announce that we’ll start working on evaluating all documentations beginning today to redesign them according to the above principles!
However, all stable and rolling documentations that were branched before February 15th won’t be updated to preserve the history and to show users how we evolved from traditional but wordy docs to minimalistic and modern docs.
The rollout will start gradually on February 15th across projects, starting from the Nitrocid manual, until all documentation has been updated. This ensures that we maintain consistency while being able to update docs for new features and other changes at the same time.
Until then, check out our brand new main docs design!
Take a look!
#docs #documentation #gitbook #news #Tech #Technology #update