docs-as-code.mdx

title	description
Docs-as-Code Workflow	How I build, preview, lint, and deploy documentation using modern docs-as-code practices.

My documentation workflow follows a full docs-as-code model: version control, automated CI/CD, reproducible builds, and an opinionated toolchain.
Ensure you have Node.js v19+ and a valid docs.json configuration file before continuing.

This guide outlines how I run, preview, validate, and deploy documentation across my projects as a Senior Technical Writer specializing in docs-as-code systems.

Why Docs-as-Code?

Treating documentation like code means:

• Version control: Every change is tracked in Git with full history
• Code review: Docs go through pull requests and peer review
• Automated testing: Linters, link checkers, and spell checkers run in CI
• Continuous deployment: Changes merge to main and deploy automatically
• Developer-friendly: Use the same tools and workflows as engineering

Writing & Editing

I write all documentation in MDX (Markdown with JSX components), which allows:

• Rich interactive components alongside standard Markdown
• Reusable snippets and callouts
• Type-safe content when paired with TypeScript