Situation
Currently, the plugin has a little bit of a user guide in the Readme. That is not very helpful.
We need a proper use-case-centric user guide under doc/user_guide.md.
- Installation
- Typical use cases
Out of Scope
- Code changes
- Requirement changes
- Design changes
Acceptance Criteria
- User guide available under
doc/user_guide.md
- Screenshots under
doc/user_guide/images
- User guide linked from the README
Situation
Currently, the plugin has a little bit of a user guide in the Readme. That is not very helpful.
We need a proper use-case-centric user guide under
doc/user_guide.md.Out of Scope
Acceptance Criteria
doc/user_guide.mddoc/user_guide/images