Skip to main content

5 posts tagged with "Docs"

View All Tags

Migrating from Material for MkDocs to Zensical: A Documentation Engineer Walkthrough

· 14 min read
Faith Wachukwu
Documentation Engineer
#

If you maintain technical documentation in 2026, there’s a good chance you’re using MkDocs or Material for MkDocs.

You picked it for good reasons. You can get a docs site running in minutes, write everything in Markdown, deploy to GitHub Pages with a lightweight CI pipeline, and end up with a polished-looking documentation site without much setup.

What you might not know is that there is a shift. The team behind Material for MkDocs has introduced Zensical, a new static site generator written from scratch in Rust, and placed Material for MkDocs into maintenance mode. At the same time, MkDocs 2.0 is heading in a direction that won’t remain compatible with Material for MkDocs or much of its existing plugin ecosystem.

If your team builds docs-as-code, then this matters to you. In this walkthrough, you’ll learn what Zensical actually is, how to migrate an existing Material for MkDocs project step by step, and whether it makes sense to move now or wait.

Writing for the Engineer Who Will Replace You

· 5 min read
Faith Wachukwu
Documentation Engineer
An engineer working in the dark.

There’s a moment where you’re staring at some internal documentation at 11 PM, trying to figure out why a deployment pipeline is failing, and the doc is incomplete. It just stops like the person who wrote it got pulled into a meeting and never came back.

What Makes API Documentation Work?

· 5 min read
Faith Wachukwu
Documentation Engineer
What makes API documentation work?.

Have you ever noticed how some APIs click while others leave you scratching your head? The difference usually comes down to one thing: how well they explain themselves. After examining the documentation strategies of five tech giants — Stripe, Twilio, GitHub, Spotify, and X, clear patterns show that they transform confusing code into delightful developer experiences.

Docs and Deployments: The Power of Clear Documentation in DevOps

· 5 min read
Faith Wachukwu
Documentation Engineer

DevOps teams love talking about automation, observability, infrastructure as code, and deployment speed. But what usually determines whether systems survive incidents, handoffs, or employee exits is accurate documentation.

For teams to ship reliably, they need up-to-date runbooks, READMEs, and architecture docs. In this post, you’ll learn why documentation is non-negotiable in DevOps, the types of documentation in DevOps, best practices and common challenges, and how to overcome them. Let’s dive right in.