search

epochjs / epoch

A general purpose, real-time visualization library.
http://epochjs.github.io/epoch
MIT License
4.97k stars 278 forks source link

New GitHub Pages Site #190

Open rsandor opened 9 years ago

rsandor commented 9 years ago

The current github pages site serves as the core documentation endpoint for the project. With #189 we are moving the documentation into the repository. We will need to recreate the site so it serves more as an introduction to the library than a fully fleshed out technical documentation site.

We will need to answer the following before proceeding:

  1. Is there a designer who is willing to come up with a new layout / color scheme for the site? If anyone is/knows someone who might want to do this please comment on the ticket!
  2. What do we want to communicate and how should the site be laid out? A simple single page? Perhaps more?

Anyone who is interested in taking this on will have me as their partner moving forward, don't be afraid to get your hands dirty :)

woozyking commented 9 years ago

For point 2, single page would be fine given the number of chart types Epoch currently has. It should contain similar breakdown of the current gh-page information, with the addition of dedicated API documentations to complement to offer another way to find usage examples.