django-helpdesk icon indicating copy to clipboard operation
django-helpdesk copied to clipboard

Knowledgebase QoL improvements for v0.4

Open MrPiethon opened this issue 4 years ago • 1 comments

Great job with the KB so far. I've played around with v0.2.23 and I noticed some small QoL improvements that can/should be added in v0.3 release if it has not been added already. I will be updating this as I come across more.

  1. KB Category should have the model description field set as optional. The category title is often times plenty of context to know what you will be reading. For example, if the title is called 'Premium subscription and billing', then you would know that clicking on the view articles, you will be reading about articles in this category making the description field unnecessary.

  2. KB Category slug field should be automatically populated.

  3. KB Category should be order-able. It would be really nice if we can select the order of which the items would be shown to the user instead of first -> last.

  4. KB items should have two columns: left - related articles, right - the article itself. When browsing a KB item it would be nice to have a list of similar articles on the left-hand side (sidebar) allowing a user to quickly browse other articles in the same category without having to click view other X articles link. This would reduce the click count from 2 to 1.

  5. (Not really that important, but could be nice) Add a recently viewed KB section. If a user wanted to quickly hop back to one of the KB items they read, they can quickly do so by scrolling to the bottom somewhere and clicking on it. This section could also be grouped. Articles read from X category would be grouped under that same category.

  6. If an article is marked as not helpful, we could prompt the user for more information so that the KB item could be improved.

  7. KB should have a WYSIWYG editor instead of markdown. This would more conveniently allow us to create detailed KB item filled with images and more.

  8. KB Category should have an optional field for adding a FA class or an image.

I think these are really great first issues as well for beginners wanting to give it a shot.

MrPiethon avatar Feb 10 '21 21:02 MrPiethon

Thank you for the ideas! Some of these may be quick and easy but I don't want to hold up the 0.3 release much longer. If someone has time to look at it please do so otherwise we'll kick these ideas to the 0.4 development process when 0.3 goes live. I think 0.4 will need a bit of an overhaul to use Bootstrap 5 among other things, so it's a perfect time to rethink some of the UI and other quality improvements.

gwasser avatar May 11 '21 21:05 gwasser