Oct 21, 2024

Reorder search ranking

Product
REST API

A good ranking of search results is crucial to find the instruction you need to answer your question. We have reconfigured our search indexes to enhance the search results and better serve all of our users.

Changes in this update:
  • Reorder search ranking
  • Application identity with guest role (preview)
  • Course mobile responsive (preview)
  • REST API strict type handling
  • New application icons
Read about these changes in detail below

Reorder search ranking

The amount of instructions available for users is growing each day. With all this available knowledge, users can be more self-sufficient if they are able to find the suitable instruction. Based on previous search behavior, several enhancements have been made to improve the search results shown to the user. After this release, the same search query will result return the same results but in a better order.

Application identity with guest role (preview)

SelfGuide has several customers who deliver SaaS applications or digital services on their own. They use SelfGuide to instruct end-users about their own solution, often directly from their public website using guest access functionality.

To make this use case easier, the SelfGuide REST API is extended to support an application identity with a guest role. This application identity gives access to the Instruction search endpoint and adds the ability to list all instructions on the website or directly integrate the SelfGuide instruction search on the website.

The REST API is a preview feature, the new application identity role will be available after the release only if the feature is enabled. If you are curious about the REST API feature but do not have access yet, contact gert.kienhuis@selfguide.com.

Course mobile responsive (preview)

A few months ago, SelfGuide has been made mobile responsive for users. The mobile responsiveness does make it possible to open and use content on devices with a smaller screen like a mobile or tablet.

The course functionality was excluded from this improvement, till now. With all improvements currently made within the course (see roadmap), using a course on a mobile device could not be left behind.

Opening a course on a device with a smaller screen will automatically change the user interface to keep all functionality working. A small list of changes which have been made:

  • No navigation on het left side
  • The top bar is minimized to just a back button
  • The course outline is hidden
  • The course header, modules, sections and content list are responsive so all information stays visible
  • The practice mode for exercises can be used from a course. This includes functionality like the preface for the assignment, good and winteraction behavior on a step, reading the assignment while performing the exercise and a back matter to show the exercise result.

Note: only the left mouse button action is supported in an Exercise when shown on a mobile device, the user will automatically be informed if the exercise contains other step actions.

This feature is in preview and disabled by default, contact gert.kienhuis@selfguide.com to get access to this new functionality.

REST API strict type handling

All REST API endpoints are enhanced to better validate the incoming data types. Till now, some edge cases could cause, for example, a Boolean to be validated as a String with an unexpected processing as result.

If clients using the REST API adhere to the types as described in the documentation, this change does not have impact.

New application icons

Icons have been added for the applications below:

  • MY-LEX
  • Fortes Change Cloud
  • ProjectFlow 365
  • QicsMilestones
  • Odoo
  • CareConnections nCare
  • CareConnections Zorgapp
  • LENS business software Q-link
  • LENS business software Q-base
  • LENS business software Q-safe
  • LENS business software Performance Manager
  • SelfGuide Recorder

Ervaar zelf het gemak van SelfGuide