A tool for building intuitive code documentation

Moksh Jawa — Thu, 23 Jan 2020 20:03:32 +0000

Hi dev.to,

We're Rishabh, Aashish, Noah, and Moksh, the creators of Codeflow: a tool for building intuitive documentation for code. You can check it out here:

https://codeflow.now.sh/

As current college students, we were all lucky enough to spend our summers interning a variety of places. One common theme we found between our experiences is it was often difficult to start working on a project and typically took many rounds of discussions to understand the flow of the code. Tools like Dropbox Paper and Confluence are great at communicating high-level specifications for engineers, but fail to capture nuances needed for new engineers to continue developing.

Codeflow is our attempt at a solution. It allows engineers to easily build presentation-esque tutorials which focus on stepping through the code logically. We hope it can become a centralized repository of tutorials designed to capture an engineer's thought process and make ramp up more efficient.

Here's an example of a tutorial built using Codeflow:

https://codeflow.now.sh/tutorials/view/RishabhJain96/next.js/tree/b595dd/ck5q9b79d00000vlbn7ichp7p

At this stage, we're hoping for feedback as we try to validate this approach. Any and all thoughts are appreciated.

Thanks,

Rishabh, Aashish, Noah, and Moksh

DEV Community: Moksh Jawa

A tool for building intuitive code documentation