User documentation - cogstat/cogstat GitHub Wiki
The user documentation is displayed at https://doc.cogstat.org/, the source is stored at https://github.com/cogstat/cogstat_user_documentation/. The developer documentation is stored and displayed at https://github.com/cogstat/cogstat/wiki/.
The user documentation should preferably include:
- separate documentation for various releases
- sidebar with the menu of the topics
- table of contents of the actual page
- title
- search (in place search is preferred over external (such as Google) search)
- visitor statistics
- date of the last modification of the page
Current implementation
- GitHub Pages seems a reasonable solution with Jekyll or Sphinx.
- As a first implementation, Jekyll is used, as it seems to be simpler to implement.
- Minima Jekyll theme is used.
Moving pages from GitHub wiki to Jekyll-based GitHub Pages
- move relevant markdown pages of the old wiki to the new git
- Documentation-for-users page is the index.md
- set Pages: add GitHub Actions, GitHub Pages Jekyll; set custom domain
- add _config.yml
- modify .site-header in _sass/minima/_layout.scss to change the borderlines at the top
- for minimal version, remove menu from _includes/header.html and feed subscription from _includes/footer.html
- add Jekyll front matter with title to the pages
- add search function to _includes/header.html and remove old search instruction