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

React Docs Outdated #2438

Closed
Swivelgames opened this issue Oct 30, 2014 · 6 comments
Closed

React Docs Outdated #2438

Swivelgames opened this issue Oct 30, 2014 · 6 comments

Comments

@Swivelgames
Copy link

It seems like every time I go to look up the React.JS docs they're out of date, which has become pretty troublesome for me and my team. We have pretty much given up on referring to the documentation that resides on the site because of how unreliable and incomplete it has proven to be.

Because of this, much of our time spent on work has been struggling to figure things out on our own. This can be understandable for new libraries sometimes, but when the team developing the project is looking for other developers to take this and run with it, it would behoove them to keep the documentation up to date so that the developers testing it out or trying to work with it can adequately develop using it.

I do not have the time or energy to compile an exhaustive list of issues or outdated areas of your documentation, but one such example is the Top-Level API documentation page whose contents are either deprecated or out dated.

Methods like React.render(), React.renderToString(), and React.renderToStaticMarkup() have all changed since then as per the changelog posted by Paul O'Shannessy here

It's very hard to continue to develop when the main toolset that is being used has outdated documentation that references. Many developers out side our team share the same sentiment, that much of the documentation is very lacking.

We're trying to take what you guys have built and build some kick-ass web apps using React.JS! Help us out! 😄

@chenglou
Copy link
Contributor

0.12 just came out, and it introduces lots of (trivial, but still) breaking changes. The docs are not yet pushed, but if you check the repo's md files they're up to date.

Is this issue recent? I was under the impression that the docs page was very up to date until this week.

@zpao
Copy link
Member

zpao commented Oct 31, 2014

What's out of date here? I know there are a couple small things left to do (mention deprecated APIs, 1 new adding) but docs were otherwise updated for 0.12 launch and are pushed to the site. React.render is the latest API.

If there are mistakes or omissions, please do tell us and don't bottle this up. We can't fix problems we don't know about. This is the first we're hearing about problems to the extent you seem to be describing.

@willdady
Copy link

willdady commented Nov 2, 2014

I'm not sure if documentation for deprecated-but-still-working code is wrong but...

Prop Validation docs still shows React.PropTypes.renderable which has been deprecated for React.PropTypes.node.

@chenglou
Copy link
Contributor

chenglou commented Nov 2, 2014

#2434 solved this. Check the md files linked above for the most recent documentations. Sorry about that; keeping docs up-to-date during transition periods isn't easy but I think they've been relatively well-maintained til now =)

@willdady
Copy link

willdady commented Nov 2, 2014

@chenglou When will those changes be pushed live?

@zpao
Copy link
Member

zpao commented Nov 6, 2014

Pushed, sorry for the delay and confusion.

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

No branches or pull requests

4 participants