guess icon indicating copy to clipboard operation
guess copied to clipboard

Improve the documentation

Open mgechev opened this issue 5 years ago • 4 comments

There's a lot of place for improvement of the documentation.

  • [ ] Update the Angular guide to use ngx-build-plus
  • [ ] Improve the API documentation explaining the configuration properties
  • [ ] Include a guide showing how to use Guess.js with JWT instead of OAuth
  • [ ] Include Gatsby guide

The content of the documentation is in the GitHub page repo.

mgechev avatar Sep 26 '19 22:09 mgechev

I'll start taking a look at this

brolag avatar Sep 26 '19 23:09 brolag

Also... adding some code comments so that the code isn't so obscure and is easier to follow. I want to get in and make changes, but without any comments, it's slow going.

aaronfrost avatar Jan 17 '20 23:01 aaronfrost

@aaronfrost what part of the implementation do you find obscure so I can help? Adding comments to non-public APIs will not necessarily add much value.

mgechev avatar Jan 18 '20 17:01 mgechev

Adding comments to non-public APIs will help with people trying to comment and submit pull requests. I need to make a PR, cause there is an issue with the "Multiple Root" stuff. But trying to see what the code is doing is tough, and the why is even tougher.

Comments around the code or any documentation around any of the implementations would be nice.

aaronfrost avatar Jan 18 '20 19:01 aaronfrost