Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write extensive documentation and tutorials for all classes and methods #4

Open
10 tasks
just-ero opened this issue Oct 16, 2022 · 0 comments
Open
10 tasks
Assignees
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.

Comments

@just-ero
Copy link
Owner

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 with asl-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 documentation

    • Basic class
    • Unity class
    • Unreal class
    • Other classes
  • Tutorials

    • Setting up asl-help (testing, debugging)
    • Finding information for Unity games
    • Finding information for Unreal Engine games
  • LiveSplit documentation

    • timer
    • game
    • Signature scanning
@just-ero just-ero added 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. labels Oct 16, 2022
@just-ero just-ero self-assigned this Oct 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

No branches or pull requests

1 participant