Yashasv-Prajapati / Docify

5 stars 2 forks source link

Working Code Flow #120

Closed sarvo314 closed 2 months ago

sarvo314 commented 2 months ago
linear[bot] commented 2 months ago
CS3-142 Generate Readme - Analysis of Code with UML generators (Python)

We need to identify how does a UML generator like the one's we have used Pyreverse(Python) work to analyze source code. Or maybe find some other tool that analyzes the code for us in Python. We need to figure our how those tools analyze the code base, or maybe use similar tools to identify a flow of the whole source code that we can feed to an LLM and prompt it to generate a basic description of the Project that will work as our Generate Readme tool. Once that is figured out, take a sample python project and try to generate a text description of a generic analysis or flow of the source code using that process/tool. For example, say you have a project and the tool analyzes that your project has these classes and functions, this is how they are connected, this is what they are using, then we can use that analysis to ask an LLM to tell us an appropriate description of the project.