Documentation

[TimMikeladze]

This issue is to track parts of accounts-js which need to be documented.

API documentation

• [x] It would be a good idea to generate api documentation for all the package using the typings.

Usage documentation:

• [x] Getting started
  • [ ] REST
  • [x] GraphQL
  • [ ] React
• [ ] Cookbook
  • [x] accounts-js GraphQL micro-service and schema stitching
  • [ ] restricting to single email address
  • [ ] meteor integration
  • [x] react-native integration
• [x] Email
• [ ] Strategies
  • [x] Passwords
  • [ ] Two factor
  • [ ] Oauth
• [ ] Sessions
  • [x] JWT
  • [ ] Cookies
• [ ] Databases
  • [x] Mongo
  • [ ] Redis

[pradel]

It would be a good idea to generate api documentation for all the package using the typings.

💯 do you know a good lib to parse the typescript JsDoc?

[TimMikeladze]

https://github.com/TypeStrong/typedoc

[pradel]

So the idea will be to use this tool to generate some json and then convert the json to a markdown file?

[pradel]

just found this project https://github.com/Microsoft/tsdoc

[rjseymour66]

Hi,

I am new to Github, but I am a professional technical writer and would like to help out with your documentation. Please let me know if you still need help with the user documentation outlined at the beginning of this thread.

• Ryan

[TimMikeladze]

@rjseymour66 hi, your help would be greatly appreciated, our documentation is lacking at the moment. The majority of it can be seen in the repo's README which describes the main use cases for @accounts/boost. We need additional documentation like documenting different initialization options or some more in depth design explanations.

What are your thoughts? Any area you'd like to begin with?

Thanks again!

[rjseymour66]

Sounds great! I will be able to take a look in the next few days and get back to you with some ideas.

I look forward to working with you!

[rjseymour66]

Hey sorry for the delay - I have had a busy few weeks!

I think a good first step would be to get the existing documentation in one place. The existing documentation is a great start, and putting it in context will help.

I can use MkDocs (or a different tool) to create a static site and deploy using Github Pages - what do you think? Then we can chip away at the to do list.

[TimMikeladze]

We've got a documentation site deployed already at https://accounts-js.netlify.com using docusaurus. See the website and docs folders in the repo's root.

The website needs some work, especially the landing page.

[rjseymour66]

Ahh gotcha - my bad - still learning to navigate Github.

How about I start with the ReadMe? I think it looks really good right now, but there are a few minor grammatical fixes and other minor changes that could help. Also, it would help me to learn the app. Does that sound good? If so, I should be able to start on it this weekend.

[TimMikeladze]

@rjseymour66 Sounds good! Also feel free to join our Slack https://join.slack.com/t/accounts-js/shared_invite/enQtMjgyMzMwMzI5MjMyLTcwYzYzYjJiZThjMGMxYTUxOWMxYzY5ZmY3OGFiZWQ4MzQxYjcyMDUzNzRlYTkzNDk1M2ZlMTEwNTNjYWFmNDE

[miller-productions]

Hey there,

I discovered accounts-js earlier today and have been reading through the repo & docs.

I've picked up a minor issue in the Usage for @accounts/boost

Happy to help fix it if you would like me to? I assume that it should actually be something like...

import { AccountsBoost } from '@accounts/boost';

const accountsBoost = new AccountsBoost();

accountsBoost.listen();

Did I get that right? Is my understanding correct or have I misunderstood something?

[TimMikeladze]

@miller-productions

import accountsBoost from '@accounts/boost' is the correct import.

Will gladly accept any PRs fixing this. Thank you!

[miller-productions]

@TimMikeladze

Happy to help.

Let me see if I can figure out what environment you use locally for the doc, and then I'll have a go.

[Silks-road]

Hi there, I'm also new to GitHub. While I've done aspects of technical writing in previous job roles, I'm now looking to get into technical writing professionally, which is why I'm trying to find open source RESTful API projects to help contribute documentation towards. I was wondering if you might have any issues that you may still need some help with?

[pradel]

Hey @Silks-road sorry for the late response looks like we missed your comment :( We definitely still need some help for the documentation. The list in this issue is still relevant I think :)