Buff up your JSDocs with jsdoc-mermaid!

Buff up your JSDocs with jsdoc-mermaid!

When we built one of our new internal tools in Node, it was a no-brainer to use JSDoc syntax to document our code and the JSDoc documentation generator to turn that syntax into an easy-to-navigate HTML documentation website. But words aren’t enough to explain some of...
Insisting on Consistency: Plop

Insisting on Consistency: Plop

Fresh Starts Recently at work, I started a new application from scratch. If you’ve had this honor, then you know how energizing it can be while everything is clean and working just the way you planned; naming conventions are in place, file and directory...
Documenting Conventions

Documenting Conventions

Our team is working on a new project with Node.js on the backend. Within our team, we have some JavaScript folks and some Rubyists. While working with one of our libraries, we noticed a hole in the documentation. That hole centered around a JavaScript convention. The...
JavaScript Projects: Joining the Present

JavaScript Projects: Joining the Present

Although the wacky world of JavaScript is still very active (read: volatile), the community appears to have unified around a set of standard-ish tools and practices that make working on projects much easier. It’s worthwhile to learn these tenets of modern...