How We Auto-Generate Documentation, JavaScript Style

couellet

Charles Ouellet

Posted on June 20, 2019

How We Auto-Generate Documentation, JavaScript Style

How We Generate Our New Documentation with Sanity & Nuxt.js

We’ve spent the last few months building the new version of our shopping cart.

When we started working on it, we knew this would also mean changes in other areas of our product.

Documentation was one of them.

It meant a few specific and much-needed upgrades:

  • Improving navigation between docs versions
  • Rethinking content arborescence
  • Automating documentation generation as much as possible

We also wanted to stay true to what we preach; using the JAMstack! That meant choosing the right JavaScript tools to generate our documentation.

We ended up picking Nuxt for static documentation generation, Sanity.io to manage content, and Netlify for automated deployment. I’ll explain why later on.

In the end, it was a great opportunity to significantly enhance our docs UX for both users and our development team.

In this post, I want to show you how we did it and how you can replicate it.

Disclaimer: Keep in mind this is an ongoing beta of the v3.0 for development and testing purpose only.

→ Read the full post here

💖 💪 🙅 🚩
couellet
Charles Ouellet

Posted on June 20, 2019

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related