📄️ Documentation Workflow Overview
This guide describes how documentation is generated, copied, and rendered for Talawa Admin and API using GitHub Actions and Typedoc.
📄️ Admin Documentation Flow
This section explains the process of generating documentation for Talawa Admin and updating the Talawa Docs website.
📄️ API Documentation Flow
This section explains the process of generating documentation for Talawa API and updating the Talawa Docs website.
📄️ Why MDX Compatibility Script is Necessary
mdmdxformat_adjuster.py
📄️ TSDoc comments in Talawa API & Admin
TSDoc is a documentation standard for TypeScript projects that allows developers to write comments directly in the code. These comments can then be converted into comprehensive documentation using tools like Typedoc. In Talawa Admin and API, TSDoc is used extensively to document the various components, classes, functions, and methods.
📄️ GitHub Actions for TSDoc Validation
We have implemented a GitHub Action to validate TSDoc comments during commits or pull requests. This ensures that new or modified code adheres to documentation standards.