piotrwitek/typesafe-actions

Update API Docs to v5.0.0

piotrwitek opened this issue · 4 comments

piotrwitek commented

API Docs need to be updated to v5.0.0.

wuweiweiwu commented

Can I pick this up?

  • 👍5
calvinwyoung commented

@wuweiweiwu That would be awesome — it's been tough sorting through some of the changes in the API without proper documentation

parkerault commented

Man, this is rough. I totally appreciate that it's open source and "why don't you do it yourself?" is a legitimate question, but I just spent 2 hours trying to figure out why my actions weren't working because I'm using v5 and reading the docs for v4. Has there been any progress on this front? It's hard to justify using this in production when I can't tell the team to RTFM.

Edit: I just saw the disclaimer at the top of the README "Current API Docs and Tutorial are outdated (from v4), so temporarily please use this issue as v5.x.x API Docs.". The problem is, it's in a spot that is really difficult to notice and the text is tiny, whereas the Tutorial section, where people are far more likely to look at, links to this issue instead.

Edit2: I tweaked the README to make this more obvious master...parkerault:patch-1

  • 👍1
karltaylor commented

Had the same issue as @parkerault, it would be great API docs could be updated to v5.0.0 or to make this more obvious on the README.md.

@wuweiweiwu do you need help?