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

Documentation nit: Statocles synopsis does not indicate create makes a new Git repo #576

Open
cxw42 opened this issue Jun 21, 2019 · 1 comment

Comments

@cxw42
Copy link

cxw42 commented Jun 21, 2019

Thanks for this tool --- I am trying it out for the first time! The Statocles SYNOPSIS section gives the example sequence:

# Create a new site
statocles create www.example.com

# Create a new blog post
export EDITOR=vim
statocles blog post
...

I did not realize that create also makes a new repo. I suggest editing the above to:

# Create a new site and its Git repository
statocles create www.example.com

# Move into the new repository
cd www.example.com

# Create a new blog post
export EDITOR=vim
statocles blog post
...

What say you? Thanks for considering this request!

@cxw42 cxw42 changed the title Documentation nit: Statocles synopsis does not indicate `crreat Documentation nit: Statocles synopsis does not indicate create makes a new Git repo Jun 21, 2019
@preaction
Copy link
Owner

That is a good idea, yes. I might also rename create to generate to match the Mojolicious command (I'm moving closer to Mojolicious's way of doing things). Thanks for the report!

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