Updated GSoC 2014 Ideas (markdown)
This commit is contained in:
parent
2bfafa974e
commit
25d5698744
|
@ -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).
|
||||
|
||||
|
|
Loading…
Reference in New Issue