Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

Create docs for all framework parts #4

Open
DanTsk opened this issue Oct 19, 2018 · 7 comments
Open

Create docs for all framework parts #4

DanTsk opened this issue Oct 19, 2018 · 7 comments
Assignees
@DanTsk
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@DanTsk
Copy link
Contributor

DanTsk commented Oct 19, 2018

No description provided.

@DanTsk DanTsk added help wanted Extra attention is needed good first issue Good for newcomers labels Oct 19, 2018
@DanTsk DanTsk added this to the Odi 0.1 milestone Oct 19, 2018
@DanTsk DanTsk self-assigned this Oct 19, 2018
@DanTsk DanTsk removed this from the Odi 0.1 milestone Dec 17, 2018
@ankush981
Copy link

Hello! I'm happy to create the docs if you can guide me a little. I'm comfortable with Node and familiar with TypeScript, so it shouldn't be a huge problem. 😃

@jepotter1-archive
Copy link
Contributor

Maybe TypeDoc for autogenerating some of the docs.

@DanTsk
Copy link
Contributor Author

DanTsk commented Dec 29, 2018

@ankush981 That will be really awesome! Let Christmas holidays pass and we can discuss everything in gitter !

@DanTsk
Copy link
Contributor Author

DanTsk commented Dec 29, 2018

@JWinnie Great idea! I think it will be good for the Reference docs, but don't know about Gitbook docs. I want to have the maximum of readability, so developers can easily jump in and start hacking!
But anyway, we can try!

@ankush981
Copy link

TypeDoc is cool, but my idea is to write more descriptive, beginner-friendly guides. The best example I can provide is https://docs.djangoproject.com/ 🙂

@ankush981
Copy link

@DanTsk Cool! What's the Gitter community name?

@DanTsk
Copy link
Contributor Author

DanTsk commented Jan 2, 2019

@ankush981 https://gitter.im/odiland/community

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@DanTsk DanTsk

Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ankush981 @DanTsk @jepotter1-archive