Skip to content

API: Commit workflow is not generating automated documentation #3660

@palisadoes

Description

@palisadoes

Describe the bug

  1. The git commit used to generate automated documentation using TypeDoc.
  2. This has been disabled because the generator script was removed from the develop branch.
  3. The automated documentation has been removed from the lefthook.yml file. See screenshot.

Expected behavior

  1. Restore the functionality to the lefthook.yml file, and package.json
  2. Restore the missing script which should be in the repository history
  3. Validate the correct generation of the documentation.
  4. Fix any documentation errors. Refer to the link fixing done in Talawa Admin for guidance
    1. https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/package.json
  5. The documents need to generated as part of submitted PRs. If new documents are generated, then the PR must fail so that the pre-commit is never avoided.
  6. Submit a PR

Screenshots

Image

Additional context

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingci/cdPull requests that update GitHub Actions codedocumentationImprovements or additions to documentationunapprovedUnapproved for Pull Request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions