tmt icon indicating copy to clipboard operation
tmt copied to clipboard

Include plugin class docstring in the online docs

Open psss opened this issue 10 months ago • 3 comments

Let's allow providing an introduction text for each step plugin class so that general information can be included in the online documentation.

Plus, specifically for the provision step, let's make the hardware specification more discoverable. Also include a simple example at the very beginning of the hardware.

Pull Request Checklist

  • [ ] implement the feature
  • [ ] write the documentation
  • [ ] extend the test coverage
  • [ ] update the specification
  • [ ] adjust plugin docstring
  • [ ] modify the json schema
  • [ ] mention the version
  • [ ] include a release note

psss avatar Apr 18 '24 08:04 psss