Documentation Improvement Initiative

[Jan Hönig]

On Wednesday, 6 May 2020 at 05:25:59 UTC, WebFreak001 wrote:
> How about also cleaning up documentation how it looks on the 
> web? Like missing macros are rendered blank in ddox, so the 
> usage or the definition could get fixed. Example missing 
> something: https://vibed.org/api/vibe.db.mongo.mongo/ (ending 
> with "a dedicated utility for this called .", missing the 
> $(LINK2 ...) macro)
>
> ddox also doesn't support showing mixin templates yet, which 
> are however already reported in the JSON by the dmd 
> documentation generator thing and only need some implementation.
>
> Also something I'm finding essential and think should be added 
> to the DDoc spec: $(LREF) and $(REF) - they are used a lot in 
> phobos and (a bit biased) they are also implemented in the 
> code-d doc preview / code tips already for all packages, making 
> them look nicely already there. Even if it just suggests that 
> these are subject to implementation for each documentation 
> generator, having a well defined syntax and explanation would 
> help a lot.

Please add it to the wiki.
https://wiki.dlang.org/Documentation_improvement_initiative#The_List