Process book
Our process book is a PDF file and can be read here.
Choice of GitHub Pages
We chose to create the website on GitHub Pages because it fits pretty well the GitHub repository system and enables us to participate efficiently on the website managing. GitHub Pages works with Jekyll, a static site generator which allows to generate html pages from basic md (markdown) files. This turns out to be pretty useful when making regular blog posts where a markdown is sufficient to encode the small presentation needed for this kind of content.
Website structure
This website’s structure is pretty simple:
- a Homepage gathering the main info about the project.
- an Algo page which will contain a working javascript of the project. It is not yet implemented.
- a Posts page listing all the new updates/modifications.
- an About page with more detailed info about the group members and the course.
Website design
Similarly to the structure, the design is pretty pure:
- a basic menu bar regrouping all above pages and the icon.
- a title header with the title and description of the current page.
- the core content on a centered portion of the page, with grey margins.
- a minimalistic footer with link to the GitHub repository.
The design is clear to avoid any confusion about the principal information on the page. All pages are easily accessible via the menu and it is easy to navigate between the blog posts.
Though the design of the website may be changed, it will stay as clear as possible to help the user browsing the website.