Chatterino2: More documentation required?

Created on 10 Feb 2020  路  3Comments  路  Source: Chatterino/chatterino2

As someone in the discord recently said that the documentation was not sufficient i want to ask the question he and start a discussion.

Is more documentation required for Chatterino? If so, what types of documentation?

discussion

Most helpful comment

Docs are good,
the first idea that came to my mind is an index of where functionality is located

All 3 comments

Docs are good,
the first idea that came to my mind is an index of where functionality is located

I think if someone from discord wants to add documentantion, they just should create a PR. 馃檪

I think if someone from discord wants to add documentantion, they just should create a PR. 馃檪

I think the problem is that people want to contribute but have a hard time getting started with the code base.
#

As mentioned by @Mm2PL, I also had a hard time navigating the code structure in the beginning. (And as a matter of fact, I still have problems locating some functionality today.)
Part of it is natural, I think, but part of it could be helped by having more comprehensive (and "coherent") documentation.

IMHO, if we could all agree on a common approach to documentation, it would be very beneficial for the project.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fourtf picture fourtf  路  3Comments

fourtf picture fourtf  路  3Comments

LeaPhant picture LeaPhant  路  3Comments

kehlery picture kehlery  路  3Comments

TranRed picture TranRed  路  3Comments