ChicoState / ChicoState/PantryNode

Consolidate documentation/reports with coverage

Open
#194 9 comments 0 reactions 4 assignees Claimed by @sourabhk25 View on GitHub
Medium Priority
Dominant language
TypeScript
Stars
3
Forks
34
PR merge metrics
No merged PRs in 30d

Description

Currently, there is a dedicated `backend/docs` folder for project documentation, but I would like a consolidated docs folder that includes any relevant documentation *anywhere in the system*. We need to do the following

- [x] Move `backend/docs` to a `docs` folder in the root directory
- [ ] Consolidate coverage analysis that commits a single html report to the `docs` folder:
- [ ] The coverage analysis should run on Actions whenever a PR is created *OR* when there is a merge into main. However, the report should only be committed (and badge in `README.md` updated) when it is accepted into main.
- [x] Both backend and frontend coverage should be analyzed in a single report (not as separate scripts/tools, if it can be avoided)
- [x] Only typescript files that are in our repo (i.e. no libraries or third-party dependencies) should be analyzed

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.