Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API Docs to v5.0.0 #189

Open
piotrwitek opened this issue Oct 28, 2019 · 4 comments
Open

Update API Docs to v5.0.0 #189

piotrwitek opened this issue Oct 28, 2019 · 4 comments

Comments

@piotrwitek
Copy link
Owner

API Docs need to be updated to v5.0.0.

@wuweiweiwu
Copy link

Can I pick this up?

@calvinwyoung
Copy link

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

@parkerault
Copy link

parkerault commented Sep 25, 2020

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

@karltaylor
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants