From d77b0e8c1d8830b1f198b99fed94ac2f0a98058f Mon Sep 17 00:00:00 2001 From: Peter Harrison <16875803+palisadoes@users.noreply.github.com> Date: Wed, 25 Dec 2024 00:20:38 -0800 Subject: [PATCH] Update ideas-20250101.md --- docs/internships/gsoc/ideas-20250101.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/docs/internships/gsoc/ideas-20250101.md b/docs/internships/gsoc/ideas-20250101.md index 2291bbf..311312f 100644 --- a/docs/internships/gsoc/ideas-20250101.md +++ b/docs/internships/gsoc/ideas-20250101.md @@ -168,12 +168,9 @@ This created additional complexity in the configuration and management of the ap 1. We need an easy to use installation and configuration script for the web UI. 1. The structure of the configuration files must be maintained 1. Documentation - 1. We want to create a GitHub pages based website to: - 1. Provide an up to date user guide for the web application. - 1. Create autogenerated markdown documentation for developers from the code base based on code comments. - 1. This is already done in our Talawa\* repositories. - 1. GitHub actions must be created to ensure that the auto-generated documentation is formatted according to our standards. - 1. The site must be created using Docusaurus and the Docusaurus code must reside in the repository. + 1. Create autogenerated markdown documentation for developers from the code base based on code comments. + 1. This is already done in our Talawa\* repositories. + 1. GitHub actions must be created to ensure that the auto-generated documentation is formatted according to our standards. 1. The site must be autoupdated whenever the markdown mentioned in this section is changed. 1. Testing 1. We want to achieve 100% test code coverage for the repository using GitHub actions @@ -215,13 +212,10 @@ This created additional complexity in the configuration and management of the ap 1. We need an easy to use installation and configuration script for the web UI. 1. The structure of the configuration files must be maintained 1. Documentation - 1. We want to create GitHub pages based websites to: - 1. Provide an up to date user guide for the API and poller applications. - 1. Create autogenerated markdown documentation for developers from the code base based on code comments. - 1. This is already done in our Talawa\* repositories. - 1. GitHub actions must be created to ensure that the auto-generated documentation is formatted according to our standards. - 1. The sites must be created using Docusaurus and the Docusaurus code must reside in the respective repositories. - 1. The sites must be autoupdated whenever the markdown mentioned in this section is changed. + 1. Create autogenerated markdown documentation for developers from the code base based on code comments. + 1. This is already done in our Talawa\* repositories. + 1. GitHub actions must be created to ensure that the auto-generated documentation is formatted according to our standards. + 1. The site must be autoupdated whenever the markdown mentioned in this section is changed. 1. Testing 1. We want to achieve 100% test code coverage for the repository using GitHub actions 1. We also want GitHub actions to fail if codecov.io code coverage criteria are not met and coderabbit.io does not approve the PR.