input-output-hk / input-output-hk/plutus-testing-tool

PBT Extension - Test Tree - Documentation

Open
#87 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The following will list out what needs to be included in the documentation so that users will know how to interact with the test tree feature of the extension:

- [ ] Document what environment setup and dependencies are required for the user to be able to interact with the tree
- [ ] Document what must be included in a folder so that tests can be displayed in the tree
- [ ] Document an explanation of when and why the play buttons will be disabled and what a user will need to do to enable them
- [ ] On initial tree load
- [ ] On new items added to tree after new tests added to file
- [ ] Document the different actions that can be performed in the tree
- [ ] Play
- [ ] Refresh
- [ ] Stop
- [ ] Hide/show view
- [ ] Right click context menu
- [ ] Filter
- [ ] Search
- [ ] Sort
- [ ] View results
- [ ] View code coverage
- [ ] Clear results
- [ ] View source file
- [ ] Document what the different status icons mean

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing documentation for the test tree feature and reviewing the extension's current tree behavior. Document the setup, folder requirements, disabled play-button conditions, tree actions, and status icons listed in the issue; done means every checklist item is covered clearly for users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.