cadey
/
nim-wiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated GSoC 2014 Ideas (markdown)

This commit is contained in:
Dominik Picheta 2014-02-13 04:29:02 -08:00
parent 25d5698744
commit c3d0994b66
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
GSoC-2014-Ideas.md
View File

@ -152,7 +152,7 @@ ___
**Desirable skills:** Basic writing and documentation skills, web design and infrastructure setup. **Desirable skills:** Basic writing and documentation skills, web design and infrastructure setup.
**Description**: **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. [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. The [Nimrod documentation](http://nimrod-lang.org/lib.html) 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. This project aims to change that.
**Tasks:** **Tasks:**