Feature Request: Add Landing/Home Section for each testsuite

[tmsMedcom]

Description:
Currently, we are using the gitb:documentation tag on test suites to provide related information for the user. While this works, the content is somewhat hidden behind the info button, making it less visible and less accessible to users.

It would be beneficial to introduce a more prominent “landing” or “home-like” section for each standard directly within the ITB interface. It would improved visibility and usability of documentation within ITB, hopefully leading to a better user experience.

Proposed Solution:
Add a visible content box or section on the test suite page (e.g., at the top or in a dedicated area, see suggestion below), where documentation or introductory information can be displayed. This section could function similarly to a landing page and make key information immediately accessible without requiring extra clicks.

[costas80]

Hi @tmsMedcom - thanks for the suggestion.

In relation to this, have you considered providing a more elaborate description for the domain / specification /actor (depending on what level your conformance statements are at) with additional context information?

This is immediately displayed on the conformance statement detail page and in relevant reports. In addition, users that don't want to view this repeatedly can minimize the display of the conformance statement's details.

[tmsMedcom]

Hi @costas80

Thanks for pointing it out. It seems like this could indeed be useful. However, would it be possible to support HTML formatting in that field?

[costas80]

However, would it be possible to support HTML formatting in that field?

This is not possible currently but we could add support for it. Currently the information that gets displayed here (domain, specification, specification group, actor) has a description which is simple text. We cannot support HTML in this directly, given that we need to know when we need to render content as HTML and strictly sanitize it as such. Moreover, this information is not only displayed in this screen, and any HTML content introduced would likely not be generally suitable for any display.

Considering this, my thought is to add a new optional documentation property which specifically supports HTML. If provided, this will be displayed instead of the text-only description in the conformance statement detail screen, and potentially in PDF/XML conformance statement reports. The HTML supported here would be limited, including text formatting, blocks, lists, limited styling and links.

How does this approach sound?

[tmsMedcom]

It sounds like a great approach. It gives us the opportunity to add more relevant information in a user-friendly way.

[costas80]

Great - thanks for confirming! In terms of display we'll experiment a bit to see how to present this best. The extended documentation will surely be contained within the "details" panel to allow users to hide it if desired, but we'll see if we keep this alongside the existing description or replace it. In any case I'll ping you here when the first iteration of this is available on our nightly build channel to see what you think.