Suggestion - user notes in documentation

I always found the user notes in PHP docs super helpful.

just picking one random page to show it in action: https://www.php.net/manual/en/reserved.variables.request.php

Often the rails docs are pretty thin. User notes can contribute the helpful ‘here is an example/insight’

The clear demarcation between docs and user notes tacitly acknowledges that the user comments may need to be taken with a pinch of salt!

1 Like

We were discussing this last week, talking about how useful (although often wildly out of date) the comments are in APIDock.

Walter

My concern here is how that kind of thing would be moderated. User-generated content spaces always seem attractive until bad actors show up and start “generating content.”

1 Like

does anyone know how php & stack overflow manage it?

the php page shows some insight on what they’re doing:

https://www.php.net/manual/add-note.php