Gitbook documentation

[anykeyh]

Gitbook documentation

The current inline documentation is not yet user-friendly. Clear offers thousand of different possibilities and can be a bit confusing at first glance for a beginner user.

A step by step guide plus an advanced documentation about all the API should helps people to get used to Clear.

As I'm not a native english speaker, if anybody want to help me to proof the documentation, rewrite the bad sentences or fix the grammar, it would be awesome 😍

URL of the guide: https://clear.gitbook.io/project/

[jackturnbull]

I'm willing to help out with this where I can, and where I see issues with the documentation. I highly rate this library from a technical point of view and upgrading the documentation will help to get new users so I see it as a vital piece of the overall infrastructure.

With that being said, I have a couple of suggestions:

Although it's nice to have the offline navigation as separate markdown, I think the project is too small to have two separate sets of documentation. Examples will drift and not being able to version documentation changes across gitbook and this git repository add extra maintainance headache.

I'd suggest doing one of these things:

• Sync the gitbook documentation to github: https://docs.gitbook.com/integrations/github
• Migrate to https://github.com/facebook/Docusaurus and host the documentation on github pages.

I don't have a great deal of experience with either but my strong suggestion would be to move away from two sources of truth on the documentation.

[anykeyh]

Oh ! It seems like I've overlooked the two side integration between gitbook and github. It seems to be the answer to keep documentation sync and to allow members contribution to the doc through PR.

I'll check on it today ! Thank you for your help 😄 !!