typesafe-actions icon indicating copy to clipboard operation
typesafe-actions copied to clipboard

Update API Docs to v5.0.0

Open piotrwitek opened this issue 6 years ago • 4 comments

API Docs need to be updated to v5.0.0.

piotrwitek avatar Oct 28 '19 10:10 piotrwitek

Can I pick this up?

wuweiweiwu avatar Mar 25 '20 19:03 wuweiweiwu

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

calvinwyoung avatar Apr 02 '20 07:04 calvinwyoung

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 https://github.com/piotrwitek/typesafe-actions/compare/master...parkerault:patch-1

parkerault avatar Sep 25 '20 04:09 parkerault

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?

karltaylor avatar Mar 10 '21 15:03 karltaylor