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

Better documentation #12

Merged
merged 3 commits into from
Aug 15, 2013
Merged

Better documentation #12

merged 3 commits into from
Aug 15, 2013

Conversation

benbalter
Copy link
Contributor

Flesh out better documentation with a few ends:

  1. Clarify the project goals, what's in scope, and what's not
  2. Clarify what issues belong here, and what belong on either Jekyll or GitHub Support
  3. Clarify how to contribute

/cc #6

@benbalter
Copy link
Contributor Author

@tombell great catches both. Thanks for taking the time to review so closely.

benbalter added a commit that referenced this pull request Aug 15, 2013
@benbalter benbalter merged commit 9af6e96 into master Aug 15, 2013
@benbalter benbalter deleted the better-docs branch August 15, 2013 14:02
@kevinSuttle
Copy link

I'd like to point out also that this does not run a production environment of GitHub Pages on your local machine, so things like pretty rewrites from about.html to /about isn't going to happen. I've seen some confusion about this, myself included.

@tombell
Copy link

tombell commented Aug 18, 2013

It runs Jekyll like the production environment, not serve your site like the production environment.

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

Successfully merging this pull request may close these issues.

None yet

3 participants