Waffle icon indicating copy to clipboard operation
Waffle copied to clipboard

Update/review packages READMEs/docs

Open wachulski opened this issue 4 years ago • 0 comments

I found some docs/READMEs out of sync/date. E.g. #489

Also in some READMEs:

In the current version of waffle (v2.x.x) you will (...)

The current is 3.3.0/3.3.1

I propose a task to overhaul docs around here. We can think about some ideas to prevent it from happening in the future:

  1. decouple some numbers, e.g. removing v2.x.x away
  2. creating a shared pieces of docs (linking/automation/generators/etc.)
  3. create a recurring task before e.g. each major version

wachulski avatar Apr 19 '21 08:04 wachulski