High Fidelity API Reference
Tools Used: JavaScript, JSDoc, GitHub Pages, Markdown, HTML, CSS
Before I joined High Fidelity, the API reference was generated using JSDoc, and then the output was extracted and merged with Markdown templates via a custom JavaScript script. This script required constant maintenance, and the iterative process of generating, merging, and re-creating files introduced significant inefficiencies.
After analyzing the existing architecture, I proposed a full migration to JSDoc for both documentation generation and formatting, with GitHub Pages for hosting. This eliminated the need for multiple interdependent tools and scripts, streamlining the process while giving us greater control over branding, design, and implementation.
View the API reference here: https://ingerjm0.github.io/writing-portfolio/dev/api/index.html.
