-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Open
Labels
bugSomething isn't workingSomething isn't workingci/cdPull requests that update GitHub Actions codePull requests that update GitHub Actions codedocumentationImprovements or additions to documentationImprovements or additions to documentationunapprovedUnapproved for Pull RequestUnapproved for Pull Request
Description
Describe the bug
- The
git commitused to generate automated documentation using TypeDoc. - This has been disabled because the generator script was removed from the develop branch.
- The automated documentation has been removed from the
lefthook.ymlfile. See screenshot.
Expected behavior
- Restore the functionality to the
lefthook.ymlfile, and package.json - Restore the missing script which should be in the repository history
- Validate the correct generation of the documentation.
- Fix any documentation errors. Refer to the link fixing done in Talawa Admin for guidance
- 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.
- Submit a PR
Screenshots
Additional context
- Plugin: Test the generation automated documentation as part of the PR GitHub Action talawa-plugin#61
- Admin: Test the generation automated documentation as part of the PR GitHub Action talawa-admin#4424
- API: Commit workflow is not generating automated documentation #3660
Potential internship candidates
Please read this if you are planning to apply for a Palisadoes Foundation internship
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingci/cdPull requests that update GitHub Actions codePull requests that update GitHub Actions codedocumentationImprovements or additions to documentationImprovements or additions to documentationunapprovedUnapproved for Pull RequestUnapproved for Pull Request