Doc Update: Automation of project structure updation using GitHub workflows and Python scripts #71
Closed
4 tasks done
Labels
documentation
Improvements or additions to documentation
gssoc-ext
GSSOC'24 Extd Participant
hacktoberfest-accepted
hacktoberfest accepted
level1
awards 10 points
Describe the Documentation Update
Describe your chaotic idea
Currently, the project doesn't have a project structure. And, it would be a bit difficult for newcomers to understand the project and how to add more chaos to it's existing structure completely. Also, it's difficult for anyone to manually change the project structure as it grows in size day by day. So, automating this with GitHub workflows and Python script will make the maintenance easier and enhance organised chaos(metaphor!).
I want to add a detailed project structure in a separate file(redirect in README.md) for the contributors to refer to and automate its updation process as new files are added in the projects. This will help them refer to the structure and will make it easier for them to understand the structure and spread more chaos to the project. Also, it's difficult for anyone to manually change the project structure as it grows in size day by day. So, automating this with GitHub workflows and a Python script will make the project more accessible to the Contributors and spread more chaos.
Add Screenshots (if applicable)
Add Screenshots or Sketches
Sample of how the workflow would be automated and the project structure after updation in readme:
Confirm
The text was updated successfully, but these errors were encountered: