Difference between revisions of "Documentation improvement initiative"
(Created page with "This is an unsorted list of tasks, which improve the documentation. The original thread on the forum can be found [https://forum.dlang.org/post/xqovfyklaxjmxxhpdwdx@forum.dlan...") |
(→The List) |
||
| Line 18: | Line 18: | ||
| 5 ||opinionated suggestions in getting started https://wiki.dlang.org/Getting_Started (a newcomer is overwhelmed by the possibilities of compilers,editors/ides. Suggestions: dmd, vscodium with code-d) | | 5 ||opinionated suggestions in getting started https://wiki.dlang.org/Getting_Started (a newcomer is overwhelmed by the possibilities of compilers,editors/ides. Suggestions: dmd, vscodium with code-d) | ||
|- | |- | ||
| − | | 6 || | + | | 6 ||pack this task list somewhere on the wiki || done |
|- | |- | ||
| 7 ||Encourage newcomers to edit the wiki. This is a simple task, often dull to do for experienced community members, but great for newcomers, because they are included AND they explore the wiki ant the community on themselves. | | 7 ||Encourage newcomers to edit the wiki. This is a simple task, often dull to do for experienced community members, but great for newcomers, because they are included AND they explore the wiki ant the community on themselves. | ||
Revision as of 15:55, 5 May 2020
This is an unsorted list of tasks, which improve the documentation. The original thread on the forum can be found here.
The List
| Id | Description | Info / Guides / People working on |
|---|---|---|
| 1 | promote wiki.dlang.org directly on D's webpage | |
| 2 | promote authors to copy/write/(at least link) articles/tutorials/cookbooks on the wiki (there are many, but also many are scattered threw out the web) | |
| 3 | decrease score of packages, which don't build on code.dlang.org | |
| 4 | Language and library reference have enough examples (at least the parts I use). Examples are simple and clear. However to a newcomer needs also more complex examples, like tutorials or cookbooks. Idea: one link, on the specific reference to a section with related articles/tutorials/cookbooks. | |
| 5 | opinionated suggestions in getting started https://wiki.dlang.org/Getting_Started (a newcomer is overwhelmed by the possibilities of compilers,editors/ides. Suggestions: dmd, vscodium with code-d) | |
| 6 | pack this task list somewhere on the wiki | done |
| 7 | Encourage newcomers to edit the wiki. This is a simple task, often dull to do for experienced community members, but great for newcomers, because they are included AND they explore the wiki ant the community on themselves. | |
| 8 | Finish the book https://github.com/PhilippeSigaud/D-templates-tutorial |
