Developer forum

Forum » Swift » AI generated Swift documentation

AI generated Swift documentation

Justin Sjouw Dynamicweb Employee
Justin Sjouw
Reply

Hi All,

I came across a nice tool from Devin, it will take a GitHub repository, and generate documenation based on this.

I fed it the Swift repository, and it generated this overview: https://deepwiki.com/dynamicweb/Swift/1-overview

Pretty good stuff I would say :-)

Best regards,

Justin


Replies

 
Nicolai Pedersen Dynamicweb Employee
Nicolai Pedersen
Reply

Interesting - will give it a look!

 
Karsten Thuen Dynamicweb Employee
Karsten Thuen
Reply

Hi Justin

Here are my first impressions. I really like all the flow charts. They make it visual what our code actually does. And I think we can learn a lot from it, especially when we do re-implementations or want to know what i.e. Add to cart actually does.

I am a little worried if everything stated, is actually true? Especially when the code is not as consistent as we would have liked it to be. That would require a deep read through. 

But on the other hand there is a lot that looks like really good stuff. 

Well done


Best regards 
Karsten Thuen

 
Justin Sjouw Dynamicweb Employee
Justin Sjouw
Reply

Hey Karsten,

Indeed, the flowcharts are particulary good. Especially for people new to working with Swift this can make a big difference in understanding how all different parts are connected.

As with all AI generated stuff it is always good to be a bit skeptical of the accuracy, which will probalby not be 100%, but most I have seen so far seems to pan out.

I'll keep an eye on any errors, and see if there is a good way of correcting them.

Another pretty awesome feature I think is the ability to make a "codemap", for example, I needed to make some changes to the preferences dialog but don't now where to start, with the codemap I found what I needed in a few minutes: https://deepwiki.com/search/how-do-i-make-changes-to-the-p_0fe5bbf1-c49d-4132-b909-bb145b499674

have a nice weekend!

Justin

 

You must be logged in to post in the forum