can i help ?

[ys-oo]

Hi @foobar404 , I absolutely love your library! I was in the process of creating my own JavaScript audio visualization library before I discovered your amazing work. The only other solution I found was WaveSurfer, but it didn't appeal to me for various reasons. I've noticed that your library is relatively new and could benefit from some enhancements. One area that seems to need improvement is the documentation. It can be challenging for those not familiar with TypeScript or those who prefer step-by-step guides. I have expertise in JavaScript, TypeScript, and React JS, although I haven't previously contributed to an open-source project.

Would it be possible for me to contribute? Perhaps we could collaborate on developing a more comprehensive documentation site. I'm eager to play a significant role in your project and would love to help create an engaging documentation site, possibly using Next.js. If you're looking for someone to assist in building a robust documentation website, both in terms of coding and potentially writing guides, I believe I'm the right person for the job!

I need someone to have a conversation with about a few aspects of project management. As I mentioned, I haven't contributed to an open-source project before. With a bit of guidance on your Git model, preferences, and best practices, along with some planning, I could potentially play a significant role in this awesome project. I have plenty of time available, possibly over 4 hours each day, to dedicate to this project.

thank you <3

[foobar404]

The docs are generated by a TSDoc parser, there are comments above each of the component that has a description and the Typescript types are used to generate the docs. I agree the docs would be a lot better if there were more examples and text and less type information. If we can find a way to integrate some of the things you mentioned into the code itself as comments or part of the TSDoc workflow that would be great. Doing that would help prevent the docs from becoming out of date, although I haven't worked on the project in some time. Let me know if you can get the GitHub repo up and running locally on your end. The main branch has all the logic to generate the docs. If you look at the project.json there should be some commands you can run to trigger the doc parser.

…

On Fri, Dec 15, 2023, 10:56 PM ys-oo ***@***.***> wrote: Hi @foobar404 <https://github.com/foobar404> , I absolutely love your library! I was in the process of creating my own JavaScript audio visualization library before I discovered your amazing work. The only other solution I found was WaveSurfer, but it didn't appeal to me for various reasons. I've noticed that your library is relatively new and could benefit from some enhancements. One area that seems to need improvement is the documentation. It can be challenging for those not familiar with TypeScript or those who prefer step-by-step guides. I have expertise in JavaScript, TypeScript, and React JS, although I haven't previously contributed to an open-source project. Would it be possible for me to contribute? Perhaps we could collaborate on developing a more comprehensive documentation site. I'm eager to play a significant role in your project and would love to help create an engaging documentation site, possibly using Next.js. If you're looking for someone to assist in building a robust documentation website, both in terms of coding and potentially writing guides, I believe I'm the right person for the job! I need someone to have a conversation with about a few aspects of project management. As I mentioned, I haven't contributed to an open-source project before. With a bit of guidance on your Git model, preferences, and best practices, along with some planning, I could potentially play a significant role in this awesome project. I have plenty of time available, possibly over 4 hours each day, to dedicate to this project. thank you <3 — Reply to this email directly, view it on GitHub <#95>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG22BHKXD763PHJ74QVMFBTYJUSZNAVCNFSM6AAAAABAXKJJ2SVHI2DSMVQWIX3LMV43ASLTON2WKOZSGA2DINRQHAZDANQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ys-oo]

The docs are generated by a TSDoc parser, there are comments above each of the component that has a description and the Typescript types are used to generate the docs. I agree the docs would be a lot better if there were more examples and text and less type information. If we can find a way to integrate some of the things you mentioned into the code itself as comments or part of the TSDoc workflow that would be great. Doing that would help prevent the docs from becoming out of date, although I haven't worked on the project in some time. Let me know if you can get the GitHub repo up and running locally on your end. The main branch has all the logic to generate the docs. If you look at the project.json there should be some commands you can run to trigger the doc parser.
…
On Fri, Dec 15, 2023, 10:56 PM ys-oo @.> wrote: Hi @foobar404 https://github.com/foobar404 , I absolutely love your library! I was in the process of creating my own JavaScript audio visualization library before I discovered your amazing work. The only other solution I found was WaveSurfer, but it didn't appeal to me for various reasons. I've noticed that your library is relatively new and could benefit from some enhancements. One area that seems to need improvement is the documentation. It can be challenging for those not familiar with TypeScript or those who prefer step-by-step guides. I have expertise in JavaScript, TypeScript, and React JS, although I haven't previously contributed to an open-source project. Would it be possible for me to contribute? Perhaps we could collaborate on developing a more comprehensive documentation site. I'm eager to play a significant role in your project and would love to help create an engaging documentation site, possibly using Next.js. If you're looking for someone to assist in building a robust documentation website, both in terms of coding and potentially writing guides, I believe I'm the right person for the job! I need someone to have a conversation with about a few aspects of project management. As I mentioned, I haven't contributed to an open-source project before. With a bit of guidance on your Git model, preferences, and best practices, along with some planning, I could potentially play a significant role in this awesome project. I have plenty of time available, possibly over 4 hours each day, to dedicate to this project. thank you <3 — Reply to this email directly, view it on GitHub <#95>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG22BHKXD763PHJ74QVMFBTYJUSZNAVCNFSM6AAAAABAXKJJ2SVHI2DSMVQWIX3LMV43ASLTON2WKOZSGA2DINRQHAZDANQ . You are receiving this because you were mentioned.Message ID: @.>

so it's a top priority to have a doc generated from code comments ?

[ys-oo]

The docs are generated by a TSDoc parser, there are comments above each of the component that has a description and the Typescript types are used to generate the docs. I agree the docs would be a lot better if there were more examples and text and less type information. If we can find a way to integrate some of the things you mentioned into the code itself as comments or part of the TSDoc workflow that would be great. Doing that would help prevent the docs from becoming out of date, although I haven't worked on the project in some time. Let me know if you can get the GitHub repo up and running locally on your end. The main branch has all the logic to generate the docs. If you look at the project.json there should be some commands you can run to trigger the doc parser.
…
On Fri, Dec 15, 2023, 10:56 PM ys-oo @.> wrote: Hi @foobar404 https://github.com/foobar404 , I absolutely love your library! I was in the process of creating my own JavaScript audio visualization library before I discovered your amazing work. The only other solution I found was WaveSurfer, but it didn't appeal to me for various reasons. I've noticed that your library is relatively new and could benefit from some enhancements. One area that seems to need improvement is the documentation. It can be challenging for those not familiar with TypeScript or those who prefer step-by-step guides. I have expertise in JavaScript, TypeScript, and React JS, although I haven't previously contributed to an open-source project. Would it be possible for me to contribute? Perhaps we could collaborate on developing a more comprehensive documentation site. I'm eager to play a significant role in your project and would love to help create an engaging documentation site, possibly using Next.js. If you're looking for someone to assist in building a robust documentation website, both in terms of coding and potentially writing guides, I believe I'm the right person for the job! I need someone to have a conversation with about a few aspects of project management. As I mentioned, I haven't contributed to an open-source project before. With a bit of guidance on your Git model, preferences, and best practices, along with some planning, I could potentially play a significant role in this awesome project. I have plenty of time available, possibly over 4 hours each day, to dedicate to this project. thank you <3 — Reply to this email directly, view it on GitHub <#95>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG22BHKXD763PHJ74QVMFBTYJUSZNAVCNFSM6AAAAABAXKJJ2SVHI2DSMVQWIX3LMV43ASLTON2WKOZSGA2DINRQHAZDANQ . You are receiving this because you were mentioned.Message ID: @.>

do you have any preferences when it come to docs ? what do you think about docusaurus.io ?

[foobar404]

Ill look into some more doc libraries and resources tonight, ill take a look at docusaurus.io too. If you can check out TSDoc and see if its flexible enough to do the things you have in mind.

[ys-oo]

Ill look into some more doc libraries and resources tonight, ill take a look at docusaurus.io too. If you can check out TSDoc and see if its flexible enough to do the things you have in mind.

check docusaurus-plugin-typedoc it's a plugin that i think will help us in this case

i tried multiple doc libraries before , docusaurus was the best for me in the best as i converted my jsdoc to a good looking doc with the ability to easily write step by step guides for newcomers

[foobar404]

@ys-oo hey I took a look at docusaurus-plugin-typedoc, and it seems like it should integrate pretty well into the current setup. As far as I understand, docusaurus will generate a doc site from markdown files, and this plugin will help us create the markdown files from the current types, I'm assuming there is also a way to add in extra info like paragraphs and examples to explain methods? Also, I would need the static HTML files generated by docusaurus to be placed in a specific location, I assume that's possible but am not sure how. Let me know if you think any of that is possible, and feel free to try to implement docusaurus-plugin-typedoc into the project on your local branch and see how it goes, I'm here if you need assistance.