Skip to content

Commit

Permalink
Update ideas-20250101.md
Browse files Browse the repository at this point in the history
  • Loading branch information
palisadoes authored Dec 25, 2024
1 parent e7dc6a3 commit d77b0e8
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions docs/internships/gsoc/ideas-20250101.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit d77b0e8

Please sign in to comment.