SAP / guided-answers-extension

Enable community collaboration to jointly promote, develop and consume a VSCode extension which provides a simple interactive way to show the developers how to troubleshoot issues, navigate processes and guide through tasks via the content published to SAP's Guided Answers (https://ga.support.sap.com/dtp/viewer/).
Apache License 2.0
9 stars 4 forks source link

FEATURE - API - EXT - Enhance search results to show relevant node(s) #309

Open theStiggySpd opened 1 year ago

theStiggySpd commented 1 year ago

As a developer using Guided Answers extension, I want to see exact nodes which meets my search criteria, so that I I precisely know which node to navigate under a tree rather than tying everywhere

Description

image

Visual Design

https://www.figma.com/file/XSZw3w81MYY0QPe1BoUcBO/Guided-Answers?node-id=0-1&t=DBvpIqLbgZKX3mRm-0

Screenshot 2023-03-28 at 12 57 22

Screenshot 2023-09-28 at 12 21 21

Technical Design

Needs inputs from both @Klaus-Keller and @JonWiens (Guided Answers API needs to be enhanced)

Acceptance Criteria

  1. On entering search criteria all nodes/outcomes of a tree that that contain or match the search input will be displayed in the returned Guided Answer list. The nodes displayed will be limited to two.

  2. On click of a node/outcome the user will be navigated to that specific node in the tree. No path will be shown as the user will not have navigated through the other nodes in the tree to arrive at that specific node.

  3. On first load , If there are multiple nodes of tree that match the search input then only two will be displayed at first but the user can click to show more if there is more.

  4. On click of view more results, all the nodes matching the search criteria will be displayed. The user won't be able to collapse individual trees but the user has the ability to collapse all trees and expand all trees.

  5. On collapse of all trees just the trees display. Trees that have nodes matching the search input will have a View X more results within the tree description.

  6. On click of the tree in the list the user will be navigated to the start of the tree.

  7. Notes

    Tasks

    • [ ]
    • [ ] Unit Tests added
    • [ ] Test Cases defined
gpeuc commented 1 year ago

Updated the highlights, we are not doing brutal yellow ones. Found search query is bold (or if it's already bold, it just stays bold, like in the titles).

List of answers - DEEP LIST
carwelsh commented 1 year ago

@unseen1980 - I updated the story regarding the different view modes.