fix documentation workflow for talawa-admin #1300
Conversation
Our Pull Request Approval ProcessWe have these basic policies to make the approval process smoother for our volunteer team. Testing Your CodePlease make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:
The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing. ReviewersWhen your PR has been assigned reviewers contact them to get your code reviewed and approved via:
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1300 +/- ##
=======================================
Coverage 92.77% 92.77%
=======================================
Files 134 134
Lines 3238 3238
Branches 904 904
=======================================
Hits 3004 3004
Misses 225 225
Partials 9 9 ☔ View full report in Codecov by Sentry. |
|
This needs to be merged against the develop branch. Please close and reopen a PR |
| npm install --global typedoc | ||
| npm install typedoc-plugin-markdown | ||
| npm install --save-dev @types/node | ||
| npx typedoc --entryPoints src/components src/screens --out talawa-admin-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand --exclude "**/*.test.ts" --exclude "**/*.css" |
There was a problem hiding this comment.
What have you changed to ensure that the typedoc generated files will always be MPX compatible during the giving action workflow process?
There was a problem hiding this comment.
Typedoc and its markdown plugin don't natively support MPX formatting. To address this, I am considering adding a post-processing script to escape <, >, {, and } characters in the generated Markdown files. This will be complemented by a validation step using npx docusaurus-mdx-checker to ensure MPX compatibility.
There was a problem hiding this comment.
- Write a python script to do this
- Follow the Google Python style guide especially in the DocString area. https://google.github.io/styleguide/pyguide.html
- Make sure that the script is python
black,pydocstring,pylint,flake8andpycodestylecompliant - Make sure that the script uses functions. Use the
countline.pyscript in theworkflowdirectory as a guide
|
This PR needs to be made against the develop branch. Please close and reopen against develop |
What kind of change does this PR introduce?
This PR introduces a bugfix related to the automated documentation GitHub action PUSH workflow. The fix standardizes the package manager to npm for both talawa-api and talawa-admin and ensures that the markdown files are MPX compatible.
Issue Number: #1279
Did you add tests for your changes?
No. The changes are related to the GitHub Actions workflow and documentation updates. Manual testing was conducted to ensure workflow functionality.
If relevant, did you update the documentation?
Yes, the documentation has been updated to reflect the changes in the workflow and the requirements for MPX compatibility with Docusaurus v3.
Summary
This PR addresses the issue where the GitHub action for automatically generating documentation was failing due to inconsistencies in package managers and incompatibility with Docusaurus v3's MPX standards. The changes include unifying the package manager to npm and updating the documentation files to be MPX compatible, ensuring smooth operation and accessibility for developers.
Does this PR introduce a breaking change?
No, this PR does not introduce a breaking change. It aims to fix existing workflow issues without altering the functionality of the actual software.
Have you read the contributing guide?
Yes