The Wayback Machine - https://web.archive.org/web/20201217014458/https://github.com/guess-js/guess/issues/229
Skip to content

/ guess

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the documentation #229

Open
mgechev opened this issue Sep 26, 2019 · 4 comments
Open

Improve the documentation #229

mgechev opened this issue Sep 26, 2019 · 4 comments
Labels
good first issue help wanted

Comments

@mgechev
Copy link
Member

@mgechev mgechev commented Sep 26, 2019 •
edited

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.
@brolag
Copy link

@brolag brolag commented Sep 26, 2019

I'll start taking a look at this
@aaronfrost
Copy link

@aaronfrost aaronfrost commented Jan 17, 2020

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.
@mgechev
Copy link
Member Author

@mgechev mgechev commented Jan 18, 2020

@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.
@aaronfrost
Copy link

@aaronfrost aaronfrost commented Jan 18, 2020

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted
3 participants
@mgechev @aaronfrost @brolag
You can’t perform that action at this time.