Documentation Projects
Welcome to my technical documentation showcase. Below are examples of API portals and documentation suites I have engineered.
Mapping Calgary: CMS Schema Design
Information Architecture CMS Strategy Logic-Driven DocsThe Project: A deep dive into documenting a complex, logic-driven CMS schema for a municipal mapping project. This highlights my ability to translate abstract data relationships into clear, actionable documentation for developers and stakeholders.
Read the Case Study | View Original on Medium
Inventory Management System: Full-Stack Security
React.js Node/Express PostgreSQL Security ArchitectureThe Project:
A full-stack application built with a "Merchant-First" mindset. This project showcases my ability to document the interaction between a React frontend and a secure Node.js backend. It features a deep dive into stateful session-based authentication using HttpOnly cookies and strict data isolation.
View Inventory Overview | Read the Auth Deep Dive
CI/CD: Automated Documentation Pipeline
GitHub Actions YAML AutomationThe Problem: Manual deployments are prone to human error and version drift. I needed a way to ensure that as soon as a technical writer or developer pushes a change, the live site is updated instantly.
The Solution:
I engineered a custom GitHub Actions workflow that triggers on every push to the main branch.
- Environment: Ubuntu-latest runner.
- Process: Automatically installs dependencies, executes the Docusaurus build script, and deploys the static assets to GitHub Pages.
- Security: Utilizes encrypted
GITHUB_TOKENsecrets for secure deployment permissions.
View automated pipeline documentation
Petstore API (Interactive Sandbox)
OpenAPI 3.0 Docusaurus REST APIThe Project: This project demonstrates a full integration of a REST API into a documentation site. It features a live "Send Request" console, automated code snippet generation, and a responsive three-column layout.