From 2bfafa974ebd8f2de448eeed834a0e73b6a509d8 Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Thu, 13 Feb 2014 04:20:54 -0800 Subject: [PATCH] Updated GSoC 2014 Ideas (markdown) --- GSoC-2014-Ideas.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/GSoC-2014-Ideas.md b/GSoC-2014-Ideas.md index 0e9ca42..f8ed4b7 100644 --- a/GSoC-2014-Ideas.md +++ b/GSoC-2014-Ideas.md @@ -147,27 +147,19 @@ Nimrod's standard library currently has a [``fsmonitor``](http://build.nimrod-la **Mentor:** dom96 ([@dom96](http://github.com/dom96)) -___ -#### Add a cross-platform stat()-like procedure to the operating system module "os.nim" -**Desirable skills:** Knowledge of file system api's for Linux, MacOSX, or Microsoft Windows. - -**Description:** - * Implement a procedure which uses native stat-like calls on Linux, Mac, Windows, and other operating systems to gather detailed information about specific file system objects. Allow the bypassing of symlinks -and hardlinks, where possible. - -**Difficulty:** Easy - -**Mentor:** dom96 ([@dom96](http://github.com/dom96)) - ___ #### Enhance and expand standard library documentation **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. + +**Tasks:** + * Ensure that documentation exists for all public methods and modules. - * Create and design new CSS and HTML layouts for the documentation, to better fit with the main website. + * Create and design new CSS and HTML layouts for the documentation, the design should put readability above eyecandy. * Add search capabilities to the online documentation. - * Add code examples to all modules and to a procedures (where appropriate). + * Add code examples to all modules and to all procedures (where appropriate). **Difficulty:** Medium