We are in the process of migrating documentation from the current site to the new one. You can follow the status in this PR, and the preview site is here.
In the near future, we will move our guide to the same site.
This blog post will briefly show how the new Meteor.js docs will look while explaining why we are doing this change.
Before
Now
Why are we making this change?
Our current docs have more than eight years of existence, and because of that, code examples, APIs, and the UI sometimes feel outdated. In this spirit of change coming with Meteor.js v3, we decided that while updating our docs to match the new API, we should adjust the docs to fit our vision of the future of Meteor.js: Modern and connected to the JavaScript ecosystem.
API Index
In this new version, we have added an API index, a page that lists all Meteor.js APIs. It behaves similarly to an index page for a book; every item on this page links to its documentation.
Information architeture
While redesigning our new docs, we changed how the information is grouped and displayed on the page. We kept related information together.
Also, every page has an on this page section(index), so you know which API you have on this page.
Why Vitepress?
While researching which static site generator we would use, we had a lot of frameworks to pick up from, but only some addressed our needs.
While choosing, we needed it to have a good "default" template, out-of-the-box plugins, and be easy to extend its functionalities. From our research, the one that matched most criteria and felt the easiest to start and progress with was Vitepress.
We are proud of the work that we have done in these new docs. It has been a challenging journey, and there is much more to it.
If you liked what you saw today, please react to this post and do not forget to follow us on our socials:
Top comments (2)
Really important to keep docs updated readable. Meteor is a huge project and deserves the better documentation shape for his users!
Keep going, folks!
Better documentation is a code!