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

There are no man pages for doto #6

Open
Dbz opened this issue Jul 2, 2018 · 3 comments
Open

There are no man pages for doto #6

Dbz opened this issue Jul 2, 2018 · 3 comments

Comments

@Dbz
Copy link

Dbz commented Jul 2, 2018

If you just doto in the command line, then it shows you the command options, but it would be awesome if there was documentation for man doto

@Dbz
Copy link
Author

Dbz commented Jul 3, 2018

This is going to become more and more important over time, so even starting with something simple is good. People will want to know what a task vs. thread vs. event is. As your features get more complex (repo syncing), man pages will be the best place for that documentation. Plus I am willing to help contribute to them once they exist.

@tksfz
Copy link
Owner

tksfz commented Jul 3, 2018

I agree with this, but I need to write some documentation first and put it say online somewhere first I think. I was going to write a short tutorial first.

@Dbz
Copy link
Author

Dbz commented Jul 3, 2018

I would start with the man pages first personally. It'll have examples that you can put together into a short tutorial, and you can put that on your github wiki and link to it via the readme. Or if you want to get fancier, get a domain name for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants