Skip to content

Consolidate documentation/reports with coverage #194

Description

@kbuffardi

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

  • 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.
    • Both backend and frontend coverage should be analyzed in a single report (not as separate scripts/tools, if it can be avoided)
    • Only typescript files that are in our repo (i.e. no libraries or third-party dependencies) should be analyzed

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions