Skip to content
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

should re-organize, update the docs as complete as possible #332

Open
hoatle opened this issue Jun 21, 2017 · 3 comments
Open

should re-organize, update the docs as complete as possible #332

hoatle opened this issue Jun 21, 2017 · 3 comments

Comments

@hoatle
Copy link
Member

hoatle commented Jun 21, 2017

docs is really really important for the project, we must make sure new devs can follow steps by steps easily, can understand and master teracy-dev from the provided docs:

  • getting started
  • basic usage (by use cases, examples)
  • advanced usage (by use cases, examples)
  • reference guide (provided APIs, features to look up)
  • developer guide (so that devs can follow and contribute to the project)
  • anything else?
@hoatle
Copy link
Member Author

hoatle commented Jun 21, 2017

interesting related: https://medium.com/@mikeal/docs-docs-docs-1e06d17fa06f

@hoatle
Copy link
Member Author

hoatle commented Jun 21, 2017

@phuonglm @hoavt please provide the docs outline in details (topic by topic) here and I will verify to approve.

@hoatle hoatle modified the milestones: v0.6.0-dev, v0.5.0-dev Jul 24, 2017
@hoatle
Copy link
Member Author

hoatle commented Sep 8, 2017

should learn from this https://developers.google.com/style/ (thanks to @phuonglm)

@hoatle hoatle assigned hoatle and unassigned phuonglm and hoavt Aug 17, 2018
@hoatle hoatle modified the milestones: v0.6.0-dev, v0.6.0-b1-dev Sep 18, 2018
@hoatle hoatle assigned hoavt and unassigned hoatle Sep 18, 2018
@hoatle hoatle assigned hoatle and unassigned hoavt Oct 31, 2018
@hoatle hoatle removed the sprt:next label Dec 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants