Latest Updates

Documenting code, one commit at a time.

JavaScript Mermaid

Handling Mermaid Diagram Rendering Errors

Sometimes, the most challenging bugs are not in the core logic, but in the tooling around it. Recently, while working on the diagram rendering service for a project, I encountered an issue where invalid Mermaid syntax would cause the entire process to hang. Here's how I tackled it.

The Problem

The diagram rendering service, used for generating visualizations, relied on an external script to

Read more
PHP Mermaid

Improving Code Quality with Consistent Mermaid Diagram Generation

Introduction

Ensuring consistent code quality and documentation can be a challenge. One area where consistency is crucial is in the generation of diagrams for technical documentation. This post discusses how we've improved the consistency and validity of Mermaid diagrams generated as part of our technical writing process for the devlog-ist/landing project, which provides a landing page for

Read more
PHP OpenAI

Streamlining Environment Variables in Landing Page Projects

Introduction

This post addresses the importance of maintaining clean and relevant environment configurations in web development projects, specifically within the context of landing page deployments. Removing unused or obsolete variables ensures clarity, reduces potential confusion, and minimizes the risk of misconfiguration.

The Importance of Clean Configuration

Environment variables are

Read more