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

[Feature Request] Use Github Wiki to centralize documentation #386

Open
uzluisf opened this issue Mar 16, 2024 · 2 comments
Open

[Feature Request] Use Github Wiki to centralize documentation #386

uzluisf opened this issue Mar 16, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@uzluisf
Copy link

uzluisf commented Mar 16, 2024

Is your feature request related to a problem? Please describe.

At the moment documentation for ASBPlayer is spread around in the README, a few websites, and a few Youtube videos. There's not single place where I can find an explanation for ASBPlayer's varied features, aside from reading the source code. For example, as a user I'd like to know what Surrounding Subtitles Count Radius and Surrounding Subtitles Count Count are but I cannot find it anywhere.

Describe the solution you'd like

The project should keep its documentation in Github Wikis, neatly organized, and where people can contribute to it.

Describe alternatives you've considered

The alternatives would be the documentation and guides spread around in the README, a few websites, and few Youtube videos.

Additional context

N/A

@killergerbah killergerbah added the documentation Improvements or additions to documentation label Mar 16, 2024
@killergerbah
Copy link
Owner

Yes I agree

@uzluisf
Copy link
Author

uzluisf commented Mar 17, 2024

Yes I agree

Nice! I'm a developer as well and have some experience writing design docs and documentation in general at $day-job so I can potentially contribute to it whenever I get some free time in my hands :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants