r/learnjavascript • u/DirectorDurian • Dec 31 '21

✍️AI JS Documentation Writer

148 Upvotes

94% Upvoted

12 comments sorted by

8

u/DirectorDurian Dec 31 '21

VS Code: https://marketplace.visualstudio.com/items?itemname=mintlify.document

Eclipse: https://open-vsx.org/extension/mintlify/document

Open-source: https://github.com/mintlify/vscode-docs

3

u/ApplePieCrust2122 Jan 01 '22

Have you open-sourced the ai itself? Can't seem to find it. Nevertheless, this is quite amazing! Great work

10

u/[deleted] Jan 01 '22

I have a terribly pessimistic view of this after being in this era of computing professionally. If you disagree with my take that’s okay, just downvote and move on I got no plans on reading replies .

Just curious are you guys doing crystal meth? Asking for a friend.

You couldn’t use this for anything that’s internal codebase that’s proprietary because it exposes confidential IP to an external entity assuming it sends the string to a non self hosted solution, which I assume puts yourself at fault for sending code to someone else..? Then the number of people that would use this and generate false documentation.

Pro? Maybe open source with projects that have peer review benefit from it. There’s a lot of those. I hope.

6

u/DirectorDurian Jan 01 '22

Actually upvoted! I totally agree with the concerns on IP. We've been thinking about the day we started the project.

Right now, the best we're doing is being SOC 2 compliant and ensuring that no code is ever stored in our DB. In the future, we will aim to have a limited self-hosted solution for enterprises. Really appreciate the feedback tho

3

u/GuyARoss Jan 01 '22 edited Jan 01 '22

Yeah, I don't understand why this logic isn't just bundled and ran on the physical device, rather than being a network call. Seems overkill unless they wanted to do data mining on their users.

From what I see it the example, it is just assuming the return types and the input types then interpolating them into a string, then using NLP to tokenize adjectives and nouns in the function name and concating them in some sentence structure.

Either way, this is dumb to run on a remote host.

14

u/MR_Weiner Dec 31 '21 edited Dec 31 '21

Looks cool. Only thing I’d say is that the demo gif doesn’t show the generated examples very long, so it’s a bit frustrating trying to read what was generated.

Edit: I’m referring to the linked extension/GitHub pages where the gif is embedded, not the Reddit post itself.

9

u/Yantis1212 Dec 31 '21

There is a pause button

7

u/MR_Weiner Dec 31 '21

Well in that case I’m an idiot 😅

1

u/WhiteKnightC Jan 01 '22

Not in my app :(

1

u/Yantis1212 Jan 01 '22

:( I'm sorry

2

u/Terrible_Trader Jan 01 '22

I have been looking for something like this for a while. Thank you!

2

u/Ran4 Jan 01 '22

This is a terrible thing that shouldn't be used for anything but fun.