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

Created a static site for documentation #115

Merged
merged 3 commits into from
Jan 12, 2017
Merged

Created a static site for documentation #115

merged 3 commits into from
Jan 12, 2017

Conversation

ibnesayeed
Copy link
Contributor

@ibnesayeed ibnesayeed commented Jan 12, 2017

I have created a basic static documentation site. We need to add navigation among pages, currently only the home page links to other pages. The text is mostly the same as current README, except a few places that are modified to better unify the style. And in few places more text is added. In order for it to be served properly, the repo needs to be configured to serve static pages from the docs folder of the master branch. This idea was first tossed in #95.

@Ch4s3
Copy link
Member

Ch4s3 commented Jan 12, 2017

Does it make sense to do this in the same repo?

@ibnesayeed
Copy link
Contributor Author

ibnesayeed commented Jan 12, 2017

Does it make sense to do this in the same repo?

Yes, absolutely! This way the maintenance will be a lot easier and timely. Also, I have made sure not to add any development dependency for this. The two gems required to build the page jekyll and github-pages are added in the Dockerfile, because the pages will be built by GitHub anyway. docks/development.md file towards the bottom has documentation about how to run the docs in development environment.

@Ch4s3
Copy link
Member

Ch4s3 commented Jan 12, 2017

ok. This is setup to use /docs as the github pages source right?

@Ch4s3 Ch4s3 merged commit 6db557c into jekyll:master Jan 12, 2017
@ibnesayeed
Copy link
Contributor Author

Yes, master branch /docs folder.

@Ch4s3
Copy link
Member

Ch4s3 commented Jan 12, 2017

@ibnesayeed
Copy link
Contributor Author

Yay! It's live at http://jekyll.github.io/classifier-reborn/ now. :-)

@ibnesayeed
Copy link
Contributor Author

Once there is better navigation established among pages of the documentation and sensitive matters such as mention of license etc. are verified then we can update README to point to that and remove all the inline clutter from the README.

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.

2 participants