Giters

sbt / sbt-ghpages

git, site and ghpages support for sbt projects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs are a little thin

mslinn opened this issue · comments

commented

I blindly followed the instructions, not knowing:

  • What these commands would do (looks like a branch was created to hold documentation):
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
  • That git clean -fdx would delete any files and directories not under source control.

Should the docs suggest that the user checkout master after the gh-pages branch is created? Is there any need for them to ever directly work with gh-pages again? How can ScalaDoc be published to ghpages such that it renders in a web browser?