From 25d5698744abd2bb2d18a00251668a5fc8a13262 Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Thu, 13 Feb 2014 04:26:03 -0800 Subject: [PATCH] Updated GSoC 2014 Ideas (markdown) --- GSoC-2014-Ideas.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GSoC-2014-Ideas.md b/GSoC-2014-Ideas.md index f8ed4b7..1529fdd 100644 --- a/GSoC-2014-Ideas.md +++ b/GSoC-2014-Ideas.md @@ -131,7 +131,7 @@ The Nimrod standard library currently lacks a YAML parsing module. YAML is a pop **Mentor:** Araq ([@Araq](http://github.com/Araq)), dom96 ([@dom96](http://github.com/dom96)) ___ -#### Enhance the filesystem monitoring module ``fsmonitor.nim`` +#### Enhance the filesystem monitoring module ``fsmonitor`` **Desirable skills:** Knowledge of the Microsoft Windows API. **Description**: @@ -152,12 +152,12 @@ ___ **Desirable skills:** Basic writing and documentation skills, web design and infrastructure setup. **Description**: -The Nimrod documentation is generally good but it lacks helpful code examples. It is also using a rather old design which is not on par with some of the documentation of other software projects out there. +The Nimrod documentation is generally good but it lacks helpful code examples. It is also using a rather old design which is not on par with some of the documentation of other software projects out there. [Read the docs](https://readthedocs.org/) is a good example of documentation done well. Our documentation is currently not very attractive and lacks some useful functionality too. **Tasks:** * Ensure that documentation exists for all public methods and modules. - * Create and design new CSS and HTML layouts for the documentation, the design should put readability above eyecandy. + * Create and design new CSS and HTML layouts for the documentation, the design should put readability above eyecandy. That said, the new design should be attractive to developers. * Add search capabilities to the online documentation. * Add code examples to all modules and to all procedures (where appropriate).