bryntum / support

An issues-only repository for the Bryntum project management component suite which includes powerful Grid, Scheduler, Calendar, Kanban Task Board and Gantt chart components all built in pure JS / CSS / TypeScript
https://www.bryntum.com
53 stars 6 forks source link

Improve clarity for websockets documentation #9706

Open marciogurka opened 1 month ago

marciogurka commented 1 month ago

Forum post

"Thank you, Marcio! It wasn't obvious to find this documentation because the name "Revisions" to me seems very unclear. I was looking for some text along the lines of "real time updates" or "websockets" and neither of these terms were searchable in your docs search input. Just a user-suggestion: If y'all want to brand this feature as "Revisions" that's great, but perhaps the label in the document section should say "Real-time updates" or "Using websockets" to make it more obvious what the functionality is, and then when the user clicks in to it, you can introduce them to the concept of "Revisions"

If you didn't want to do this then perhaps you could just make terms like "websockets" and "real time" searchable and return links pointing to the Revisions documentation"

Screenshot 2024-07-30 at 4 02 41 PM

The user suggested modifying our docs to make the terms for searching for WebSockets clearer.

bmblb commented 1 month ago

Should be fixes by #9492