Suggestion re the manual

Adam D Ruppe destructionator at gmail.com
Fri Jun 10 12:13:58 UTC 2022


On Tuesday, 7 June 2022 at 21:28:30 UTC, Paul wrote:
> However, one thing I miss from my PHP days (I know - script 
> languages - Ugh), is having public comments below each manual 
> page.

One thing I missed about php was going to like php.net/trim so i 
made my website dpldocs.info/strip etc. to bring it to D. My site 
there now runs its generator on dub packages too to help search 
across the ecosystem.

I need to clean some things up since I keep running out of disk 
space as there's 100 different versions of win32 needlessly 
copied etc. lol. I'm at 99% again so need to stop procrastinating 
at some point.

But once I do that, adding a comments field to each symbol would 
be technically pretty easy to do, I could even borrow some code 
from my beloved dwidder website and just paste it in!

The hard part would probably be spam control. The dwitter site 
makes you type a magic word (which it tells you on the page) and 
it seemed ok but it also isn't on search engines whereas the 
dpldocs.info site is, so that'd probably be different.

I'm of the opinion that most the comments should generally be in 
the docs themselves, and then you can submit via PR which means 
there's a review step and much less odds of spam bots hitting it. 
Also, as a user, reading through a bunch of random comments of 
varying quality just often feels bad; there's always a few gems 
of comments in there but looking through a bunch of lower quality 
ones is not as nice as the answer just plain being there. 
Comments would probably also be exempt from version checks 
meaning they can fall out of date. Of course, seeing the date on 
the comment gives people a clue it might be old.

Nevertheless, maybe I'll do it just as an experiment. Can always 
undo it later if it has more spam than value.


More information about the Digitalmars-d mailing list