Screentogif: Developer Documentation

[nguyenlamlll]

Hi,
I have recently looked into the source code. It's a bit... big and to be honest, I'm pretty clueless.

Is there a developer documentation somewhere? Maybe I missed it. I looked in Wiki section but it isn't there. If not, I'd love to help. (And probably need some helps to get starting as well). The documentation may include these sections: What modules and components are there? What are their uses? What are the controls? At least we can get some starting points or an overview look of the whole project.

[laiqun]

just read the source code

[nguyenlamlll]

@laiqun Hey man, of course, I know how to read. And the contributors made a really great job keeping the project readable. But I'm talking about the possibility to have a unified documentation where we can levitate newcomers' experiences.

For example, It goes like:

• Windows folder hold the UI pages and windows. This .xaml file is that, and that file is something else.
• The Util folder mainly contains these stuff. File A does this. (Explain). FIle B does this, and it needs revising. Etc.

[NickeManarin]

@laiqun You are not being helpful.

@nguyenlamlll

Is there a developer documentation somewhere?

No, there's no documentation. :/

I looked in Wiki section but it isn't there.

Yeah, the wiki contains only a guide for translators and users (this one is incomplete).

If not, I'd love to help. (And probably need some helps to get starting as well)

That would be awesome! I'll explain everything that you need to know.

[laiqun]

@nguyenlamlll
After reading the source code of Author,I write some note, but only cover some part of source code.
If you like to reading it ,I will upload it for help you .

[nguyenlamlll]

@NickeManarin What format would you like and where should they be hosted? Wiki pages on Github are not so great in my opinion. One should be invited as a contributor to edit the pages, right? Or can we update the docs on the website repository? So later, we can access it like screentogif.com/docs, for example.

[NickeManarin]

For a developer documentation, it would be better to stay here, on GitHub (because the code is located in here).

[nguyenlamlll]

So a folder /Docs at the root with markdown files inside. Sounds good?
Do you use any other chat tools? I think I can start working on it now and well, gonna have quite a few of quick questions.

[NickeManarin]

So a folder /Docs at the root with markdown files inside. Sounds good?

Yes :)

Do you use any other chat tools?

Yes: Email, Discord, Twitter.

http://www.screentogif.com/contact