Write extensive documentation and tutorials for all classes and methods #4
Labels
documentation
Improvements or additions to code documentation.
good first issue
Good for newcomers.
help wanted
Issue requires advanced knowledge.
high priority
Issue is of high priority.
Since I would like
asl-help
to be as accessible as possible, it is of high priority to create understandable and extensive documentation for the possible use a developer can get out of the library. The documentation will be inspired by how the Microsoft Docs for C# are structured.As documentation is currently still very work-in-progress, it will be located on its own branch at asl-help/documentation.
Alongside documentation for
asl-help
, tutorials for using it, as well as tutorials on how to gather information to be used withasl-help
are very important.Besides these important docs, it could also be great to extend LiveSplit's own documentation to include classes which are often used in auto splitter development.
asl-help
documentationTutorials
asl-help
(testing, debugging)LiveSplit documentation
timer
game
The text was updated successfully, but these errors were encountered: