CivicTechJobs icon indicating copy to clipboard operation
CivicTechJobs copied to clipboard

Epic: Update CTJ MKDocs with technical details

Open LoTerence opened this issue 8 months ago • 1 comments

Overview

We need to add technical details for how our various components work so that new developers can quickly familiarize themselves with the project.

This documentation should follow the style set by HFLA's TDM Calculator project, using this template: https://github.com/hackforla/tdm-calculator/wiki/Checklist

This feature was requested by Bonnie and is intended to be the standard for documentation across all HFLA projects.

Action Items

We should create technical documentation for each page of our app.

  • [ ] Fill in the Technical section of the referenced Wiki page.

Resources/Instructions

  • Resources
  • Template: https://github.com/hackforla/tdm-calculator/wiki/Checklist

Example TDM issues:

  • https://github.com/hackforla/tdm-calculator/issues/1870
  • https://github.com/hackforla/tdm-calculator/issues/1862
  • https://github.com/hackforla/tdm-calculator/issues/1485

LoTerence avatar Apr 13 '25 02:04 LoTerence