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

Project README is too large! #38

Closed
JoelSpeed opened this issue Feb 3, 2019 · 1 comment · Fixed by #114
Closed

Project README is too large! #38

JoelSpeed opened this issue Feb 3, 2019 · 1 comment · Fixed by #114

Comments

@JoelSpeed
Copy link
Member

Expected Behavior

ReadMe should provide information about the project but not necessarily contain all documentation for the entire project.

Current Behavior

ReadMe has all documentation in it and is hard to navigate

Possible Solution

Set up GitHub pages with Jekyll just-the-docs theme and break the documentation into smaller, more manageable pieces.

  • Version used: 3.0.0
@JoelSpeed
Copy link
Member Author

I've started working on this on a branch jekyll-docs.

You can get this running locally by checking out the branch and running:

cd docs
bundle install
bundle exec jekyll serve # starts serving docs site on localhost:4000

For the first pass of this I think we should basically just copy and paste the existing documentation into different files and not touch the individual page content

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

Successfully merging a pull request may close this issue.

1 participant