Hacker News new | ask | show | jobs
by codeenlightener 1741 days ago
Which explanations did you like best? What about them impressed you?

I'll raise the rate limit to a very high amount in a moment!

> I am still not sure of the exact business case.

You ask a good question. I'm hoping HN helps figure that out! I think it can help Senior and Junior Developers to onboard to new codebases, especially those with new concepts.

1 comments

The language used in the descriptions is easy to understand. It reads like standard conversational English.

It is minor, but I would like to see better text layout.

What I think I would really, really want, is integration with VSCode/Sublime/etc. where the interpretations were interleaved within the actual source code and could be folded down. I would like to be able to correlate the source codes lines to the interpretations.

Thanks, I will update our info to say "conversational English."

Can you explain what you mean by text layout? Do you want it justified? Formatted differently?

> What I think I would really, really want, is integration with VSCode/Sublime/etc. where the interpretations were interleaved within the actual source code and could be folded down. I would like to be able to correlate the source codes lines to the interpretations.

Cool idea. Something like Literate Programming, where the explanations are stored in the code file? Or more like a dynamic tool that just shows dynamically generated explanations inline?

If you want to go down the Literate Programming rabbit hole with me, I have a lot of ideas around that. Your system could be applied to parsing source code and coming up with conversational descriptions, or even more exciting, going from conversation, descriptive text into source code. You are in the process of building a corpus that can used in both directions.

As for the text layout, just something a little prettier with improved spacing between descriptive blocks, bullet point and links that reference to the parsed source code. It should be just as pleasant to look at as any well-designed piece of online prose. I realize that design is subjective.