Volunteer to document fully the API

[UCN0]

Hello, I am not sure if this is the right place to post this. My issue is; I have been going through pistache doc and what I noticed is lack of proper documentation with details. If you still looking for volunteers, then I would like to volunteer to document fully the API. I believe pistache is easy and a great framework. If someone could guide me on how I could help, it would be great. I can write in English, Portuguese, Turkish and a little bit of Spanish. I have some knowledge in C++ and Qt. I believe I could make a huge contribution. Thanks

[kiplingw]

Thanks a lot @UCN0. This is a very high priority issue, but we just haven't had anyone to do this yet. Fortunately your initiative comes at a good time as @Tachi107 was about to create a libpistache-doc package as discussed here. We were discussing earlier today what to put in it. I think you two should liaise.

[UCN0]

Great. I can't wait to contribute. I will wait for the instructions on how to start. As well as follow up on the discussion.

[Tachi107]

Thanks @UCN0! We use Docusaurus for documentation. All the files are in the pistache.io directory. Every documentation page is a Markdown file under the docs folder, and to add a page to the sidebar you just need to edit sidebar.js, adding the filename without the .md extension to the array (I should've separated the quickstart from the documentation pages, but don't worry about it, I'll fix it).

[UCN0]

Gotcha. Now let's suppose that I am a normal user and you would like to document functions that are unknown to me, or anything that I am not aware of. Will I get any technical help to document what is missing? The example folder is also not complete I believe. Thanks

[Tachi107]

I've not explored all much of the library myself, but other contributors like Kip and Dennis have been using Pistache way longer then me, and I think they could help you a lot

[UCN0]

I see. Could you connect them to me? So that they may assist with the technical part while I document it? Thanks

[Tachi107]

You can often find @kiplingw on #pistache on Freenode, while @dennisjenkins75 seems to be more present here on GitHub.

I would suggest using this issue as a place for discussions, so that everyone could easily go here and maybe find something useful.

Kip and Dennis, what do you think?

[kiplingw]

@UCN0, what I suggest doing is focusing on what has already been documented first. @Tachi107 can make the necessary changes to the build and packaging environment concurrently. Once that is done it will be easier for people to contribute to the documentation. In particular @oktal who is the only person who knows how some portions of the API are suppose to work.

[Tachi107]

@stescobedo92 it seems that I can't assign you to this issue... I'm trying to see if I can after tagging you here.

Edit: nope, maybe you have to leave a comment here first.

[stescobedo92]

Okay I'll be waiting for the notification. @Tachi107

[Tachi107]

@stescobedo92 done

[stescobedo92]

Thanks @Tachi107

[ansh-devs]

Hello, @Tachi107 so is there any kind of development is being happening in the markdown files of the documentation at the current moment?

[kiplingw]

Nothing right now. I can't even remember the last time we saw a PR for anything documentation related.