hackforla / hackforla/CivicTechJobs

Epic: Update CTJ MKDocs with technical details

Open
#675 1 comment 0 reactions 0 assignees View on GitHub
complexity: large documentation feature: Documentation P4: Low PBV: dev role: backend role: frontend size: 13pt+
Dominant language
TypeScript
Stars
24
Forks
27
Avg merge
2m
Merged PRs (30d)
1

Description

### 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](https://hackforla.github.io/CivicTechJobs/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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.