mitre-attack / mitre-attack/attack-workbench-frontend

Move in-app documentation into a dialog/modal

Open
#78 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement icebox optional Points: 2 priority/low
Dominant language
TypeScript
Stars
438
Forks
79
Avg merge
1d 21h
Merged PRs (30d)
3

Description

As a user, I want to be able to access in-app documentation without leaving my current page, allowing me to read usage instructions while I'm in the middle of operating the application.

Move the in-app documentation from the current help-page, into a modal window which appears when the user clicks the help button.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the current help page and the help button in the Angular frontend, then trace how the help page is opened. Move that documentation into a modal shown from the help button, while keeping users on their current page. Done means the instructions are readable in the modal and the existing help action no longer navigates away.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.