Open irperez opened 6 years ago
That's a great idea, @irperez . But i'm quite new to Github Pages, would you mind helping me to set up the Github Pages, and tell me what i need to prepare for the documentation? I am willing to help 😄
You are the only one who can set it up. I don't have the permissions. It's in the settings tab.
As for the documentation itself, you have a solid start with your ReadMe.md file. We just need to break that down into a page per subject. And drill in with more detail and more examples. I'm willing to help with that once the pages system is setup.
Also GitHub provides themes that you can setup for it. A good example of the documentation that we need.
This project has a really good example of what we should probably be shooting for: https://jasperfx.github.io/
Note the "Getting Started" & "Documentation" links at the top right.
@lppkarl I see you setup the pages. I've gone on and got started with some setup. But lots more to do. Its something we can build on and add more detail.
See #67
@irperez Much appreciated for your help. I'll take a look of the pages, and add the details later.
I feel the one area that is lacking is really good mature documentation. If the documentation can be better explained with even more examples, I believe the use of this library will explode. Google will also put this library higher in its rankings.
My first recommendation is to setup GitHub Pages and migrate all the documentation there. Break down the documentation into sections that drill down into details.
Secondly, I think it would be a good exercise to add a lot more documentation within the library to increase the quality of the intellisense. Right now if I want to add an indicator or study what other indicators are doing, I find myself in base classes that I'm not sure what their purpose is.
If we want more contributors, we need to increase the quality of documentation.