monkeytype icon indicating copy to clipboard operation
monkeytype copied to clipboard

tutorial

Open monkeytypegeorge opened this issue 3 years ago • 24 comments

monkeytypegeorge avatar Nov 23 '20 11:11 monkeytypegeorge

@ThatOneCalculator this guy is a bot... so everything he says is automated.

Also we need a tutorial on how to use the site. Like some people ask "we need certain symbols for coding!" when you can enable punctuation or do it on quote mode. In which a tutorial would be very nice to tell you about the obscure things on the website that people don't know exist.

I do wonder... Why do people hate on this issue so much?

frogfrogfrogfrogfrog avatar Feb 23 '21 15:02 frogfrogfrogfrogfrog

Yeah there are many people asking super basic questions in the discord server all the time, like asking how to type quotes, or type more than 30 seconds.

Miodec avatar Feb 23 '21 18:02 Miodec

@Miodec how would you go about in making a tutorial?

Would it be one of those where there's a text box near a feature explaining it? Or a really long document with pictures and diagrams. Perhaps a giant flow chart?

I figure it'd have to be a tutorial that's good at explaining things while also being flexible (it can be changed or added to easily) plus since there's so much in Monkeytype you'd have to make really specific things in the tutorial easy to find.

frogfrogfrogfrogfrog avatar Mar 15 '21 16:03 frogfrogfrogfrogfrog

The floating text box kind. It highlights different features and explains what they do.

Big documents and charts are boring and people will not want to read them.

Miodec avatar Mar 15 '21 16:03 Miodec

maybe something like the one on https://typing.works

RealCyGuy avatar Jun 29 '21 00:06 RealCyGuy

Since this issue isn't gaining much traction I would like to propose an idea. As I've been scrolling through Monkeytype I've realized that Monkeytype itself is kind of a tutorial as basically everything explains itself. Instead of a tutorial box thingy how about creating a Q&A that lists basic questions that get answered that people can look at before asking on Discord or Github.

frogfrogfrogfrogfrog avatar Sep 09 '21 19:09 frogfrogfrogfrogfrog

Hi @TheeKevin this is a great idea and it is a feature I would like to work on !

DavidPotvin-jpg avatar Sep 19 '21 04:09 DavidPotvin-jpg

We could have something like VS Code's user interface overview:

VS Code's user interface overview

I'm thinking something along the lines of a transparent overlay or a help page with GIFs.

unrealapex avatar Sep 22 '21 22:09 unrealapex

Can I make a pop-up screen that displays an embedded video?

jacksonwalker0 avatar Apr 25 '22 20:04 jacksonwalker0

Unassigning due to inactivity

Miodec avatar Oct 03 '22 21:10 Miodec

Hello guys I am new to open source contribution and this site, Monkeytype is the one i have been typing on for years. So I found this issue and I think the idea proposed before, a floating box containing all the stuff would be a better idea. I'd love to work on it.

anikaitprasar avatar Jun 13 '23 08:06 anikaitprasar

Hello guys I am new to open source contribution and this site, Monkeytype is the one i have been typing on for years. So I found this issue and I think the idea proposed before, a floating box containing all the stuff would be a better idea. I'd love to work on it.

Sure, but i think i would like it to be an FAQ window instead, where you have a list of topics on the left, and the right displays the contents. Then add a link to that popup in the footer.

Miodec avatar Jun 13 '23 10:06 Miodec

ok, I'll try my best to do that. Thanks!!

anikaitprasar avatar Jun 14 '23 08:06 anikaitprasar

Sorry, but after thinking a bit about it I don't think that I will be able to do it I'll start with easier ones. sorry

anikaitprasar avatar Jun 15 '23 10:06 anikaitprasar

No worries

Miodec avatar Jun 15 '23 12:06 Miodec

@Miodec, hi I have started working on this issue, I was waiting to get a good starting point to finally ask and get the issue assigned to me, I was getting the dev env setup and generally going through the codebase to understand it. I think I have now gotten to a good point and I would request that this issue be assigned to me.

Sure, but i think i would like it to be an FAQ window instead, where you have a list of topics on the left, and the right displays the contents. Then add a link to that popup in the footer.

I am currently following the requirements you've mentioned here.

I will further discuss more details about the tutorial popup here as I proceed with the development.

athNdev avatar Jun 26 '23 08:06 athNdev

Hello @ClumsyClover may I ask how is going? Need any help?

aikooo7 avatar Sep 27 '23 21:09 aikooo7

@aikooo7 Hey there, I've just been busy with some other things, but I wouldn't mind if you were to have a look at my fork and work on it further or change it however you wished. Also feel free to further discuss things here or discord (@clumsyclover) and I will be happy to chat whenever I can.

athNdev avatar Sep 27 '23 21:09 athNdev

Hello @ClumsyClover I didn't see your ping my bad, I will look at your fork and add you in discord if needed.

aikooo7 avatar Nov 04 '23 17:11 aikooo7

Hey @aikooo7, that's okay haha, I was wondering what up with this; but that's completely fine, feel free to DM me on Discord. I would be more than fine to discuss this as I do still want this to be added to moneytype.

athNdev avatar Nov 04 '23 22:11 athNdev

Hello @Miodec , I'm thinking in using markdown for writing tutorials since it's easier to anyone write, I'm also thinking in using marked for the markdown parsing, what you think about it?

PS: When doing your judgment please be sure to check the first line of usage in marked

aikooo7 avatar Nov 15 '23 18:11 aikooo7

I guess you can use markdown,sure.

Miodec avatar Nov 16 '23 13:11 Miodec

I guess you can use markdown,sure.

Hey miodec sorry for the dumb question but I want to read a markdown file that will be in static/markdown but I can't run fs module inside popous, should I create a function in backend/src/utils/filesystem?

aikooo7 avatar Nov 18 '23 22:11 aikooo7

You can base it off of the json file loading in misc.ts.

Miodec avatar Nov 20 '23 14:11 Miodec