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.

Sign up for GitHub

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

Jump to bottom

Add the PropTypes docs back #9467

Closed
flarnie opened this issue Apr 20, 2017 · 4 comments
Closed

Add the PropTypes docs back #9467

flarnie opened this issue Apr 20, 2017 · 4 comments
Assignees
@flarnie

Comments

@flarnie
Copy link
Contributor

flarnie commented Apr 20, 2017

Where does proptypes doc live? It's confusing it's still on React object but inaccessible from the website through search or table of contents. Let's either reinstantiate it or move it fully to the standalone repo. Also it's confusing we're deprecating createClass but it still lives in the docs ("React without ES6") whereas we're just "moving" PropTypes but they're gone from the docs.
@flarnie flarnie self-assigned this Apr 20, 2017
@flarnie flarnie mentioned this issue Apr 20, 2017
Closed
49 tasks
@bvaughn
Copy link
Contributor

bvaughn commented Apr 20, 2017

Where does proptypes doc live?
Let's either reinstantiate it or move it fully to the standalone repo.

Hm, well there's the prop-types GitHub repo which is duplicated on the NPM module page- though both also link to a section on the React docs as well. That section of the React docs doesn't seem to be picked up by the site search though.

@gaearon
Copy link
Collaborator

gaearon commented Apr 20, 2017 •
edited
Loading

That section of the React docs doesn't seem to be picked up by the site search though.

Yes, I think it's because it's not linked. We shouldn't have "hidden" sections for stuff that we didn't outright deprecate. Either we should keep it a visible part of React website (IMO a reasonable way to go), or fully split it out. Seeing that this is not a reference doc (just a guide), I think we should:

  • Reinstantiate the guide in the "Advanced" section of React docs
  • Add a full API reference to prop-types README

Our guide will focus on using PropTypes in React (just like it does now), and API doc in prop-types will focus on API reference (which we should remove from the React top-level reference doc in 16 but probably worth keeping a link in the meantime).

@bvaughn
Copy link
Contributor

bvaughn commented Apr 20, 2017

I like that suggested separation.

@flarnie
Copy link
Contributor Author

flarnie commented Apr 20, 2017

Sounds good! On it.

flarnie added a commit to flarnie/react that referenced this issue Apr 20, 2017
@flarnie
Add link to 'Typechecking with PropTypes' under 'Advanced Guides'
777f875 
This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles facebook#9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
@flarnie flarnie mentioned this issue Apr 20, 2017
Merged
flarnie added a commit to flarnie/prop-types that referenced this issue Apr 20, 2017
@flarnie
Add API reference to README
a66626b 
We took the API reference from the React Docs guide on 'Typechecking
with PropTypes' and added it to this README.

Once this lands we can remove it from those docs and link to these docs.

Why? So that we make it clear that this is a separate module that can be
used with other libraries as well, and not just a feature of React. Also
hopefully this will make things more clear.

We will also open a `good-first-bug` issue for someone to improve this
README and turn it into a more complete API reference, with examples
using PropTypes with other libraries.

Fixes facebook/react#9467
@flarnie flarnie mentioned this issue Apr 20, 2017
Merged
flarnie added a commit to flarnie/prop-types that referenced this issue Apr 22, 2017
@flarnie
Add API reference to README
6e450aa 
We took the API reference from the React Docs guide on 'Typechecking
with PropTypes' and added it to this README.

Once this lands we can remove it from those docs and link to these docs.

Why? So that we make it clear that this is a separate module that can be
used with other libraries as well, and not just a feature of React. Also
hopefully this will make things more clear.

We will also open a `good-first-bug` issue for someone to improve this
README and turn it into a more complete API reference, with examples
using PropTypes with other libraries.

Fixes facebook/react#9467
flarnie added a commit to flarnie/react that referenced this issue Apr 22, 2017
@flarnie
Add link to 'Typechecking with PropTypes' under 'Advanced Guides'
6e390e3 
This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles facebook#9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
flarnie added a commit that referenced this issue Apr 22, 2017
@flarnie
Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (#9472
39ca8aa 
)

This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles #9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
gaearon pushed a commit that referenced this issue Apr 26, 2017
@flarnie @gaearon
Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (#9472
928609d 
)

This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles #9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
(cherry picked from commit 39ca8aa)
flarnie added a commit to flarnie/react that referenced this issue Jun 7, 2017
@flarnie
Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (fa…
8cfc511 
…cebook#9472)

This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles facebook#9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
(cherry picked from commit 39ca8aa)
flarnie added a commit that referenced this issue Jun 7, 2017
@flarnie
Pull all docs updates from 15-stable into 15.6-dev (#9889)
a9a8124 
In order to ensure consistency between the 15-stable and 15.6 branches, we found all the diffs present only in 15-stable and cherry-picked them onto 15.6-dev.

These are 100% documentation updates, which is why we didn't bother cherry-picking them in the first place, but having them on the 15.6-dev branch makes the two branches more consistent and that is better.

Nobody will accidentally see outdated docs on the 15.6-dev branch
these diffs won't somehow be lost or overwritten when we combine the branches to release 15.6.
Test Plan:
Manually tested the docs, looking at many of the updated pages. Also ran all tests etc.
Changelog below:
---

* Fix the proptypes deprecation warning url on the "Don't Call PropTypes Warning" doc page (#9419)

* Use the same prop-types link on the warning docs page as the main proptypes doc page

* Link to repo instead

* Docs: Clarification of setState() behavior (#9329)

* Clarification of setState() behavior

`setState()` is a frequent source of confusion for people new to React, and I believe part of that is due to minimization of the impact of the asynchronous behavior of `setState()` in the documentation. This revision is an attempt to clarify that behavior. For motivation and justification, see [setState Gate](https://medium.com/javascript-scene/setstate-gate-abc10a9b2d82).

* Update reference-react-component.md

* Signature fix

* Update to address @acdlite concerns

* Add more details

* Update proptypes doc (#9391)

* Update proptypes doc

* Removed note

* Add tabs to installation page (#9275, #9277) (#9401)

* Add tabs to installation page (#9275, #9277)

This adds tabs for create-react-app and existing apps to the installation section of the docs. The tab implementation is a simplified version of React Native's installation page.

Fixes #9275.

* Use classList instead of className

* Use same implementation as in RN

* Refractor docs to indicate that state set to props in constructor will not recieve the updated props (#9404)

* Switch Installation to a tab when hash is present (#9422)

* Updated the Good First Bug section in readme (#9429)

* Updated the Good First Bug section in readme

* Inconsistent use of quotes. Prefered single quotes instead of double quotes

* Updated Good first bug link in how_to_contribute doc.

* Undo JSX attribute quote change

* don't capitalize "beginner friendly issue"

(cherry picked from commit 36c935c)

* [Documentation] Impreove the react-component section of doc (#9349)

* Impreove react-component of doc

[#9304](#9304)

* update description

* add missing space

(cherry picked from commit 359f5d2)

* Unique headings for linking purposes (#9259)

Previously two headings were 'Javascript Expressions' - now 'Javascript
Expressions as Props' and 'Javascript Expressions as Children'
(cherry picked from commit 363f6cb)

* Update jsx-in-depth.md (#9178)

* Update jsx-in-depth.md

Line 9 isn't changed

* Move selection down

* Fix

(cherry picked from commit ccb38a9)

* Sort out conferences by date (#9172)

(cherry picked from commit 37f9e35)

* Lift state up - Updating the documentation to mention that onClick is a synthetic event handler (#9427)

* Lift state up - Updating the documentation to mention that onClick is a synthetic event handler

* Review comments - Rephrase to handle synthetic events and event handler patterns

* Tweak

(cherry picked from commit 53a3939)

* Fixed grammar (#9432)

* Update codebase-overview.md

* Some more fixes

(cherry picked from commit d724115)

* [Tutorial] ES6, installation, and button closing tag (#9441)

* adds notes to tutorial on es6 and installation

* fixes tutorial mention of opening button tag

* More writing

* Update

* Minor tweaks to tutorial

* Fix duplicate sentence

* Minor tutorial nits

* Add missing tutorial sidebar links

* Tweak tutorial structure

* FIX: Move CRA build info under it's tab page (#9452)

* FIX: Move CRA build info under it's tab page

* Add some links

* Reorganize the "following along" instructions (#9453)

* Reorganize the "following along" instructions

* Minor tweaks

(cherry picked from commit 1ce562e)

* [Docs] Add accessibility to tabs in installation documentation (#9431)

* Add accessibility to tabs in installation documentation

* Change color and fix styling

(cherry picked from commit 9526174)

* [Docs: Installation] Fix tabs responsive layout - Resubmit (#9458)

* [Docs: Installation] Fix tabs responsive layout

* Move tabs a pixel down

* Remove left margin on first tab

* Remove the long line

* Fix mobile styles

(cherry picked from commit a92128e)

* Add more details in jsx-in-depth.md (#9006)

* jsx-in-depth.md add ternary statement for javascript expressions section

* jsx-in-depth.md add explanation to get falsey values for props

* update jsx-in-depth.md

* ensure links work locally, remove section about falsey prop values

* Fix links

* Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (#9472)

This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles #9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
(cherry picked from commit 39ca8aa)

* Updates how-to-contribute.md to use JSFiddle referenced in submit Git issue template (#9503)

(cherry picked from commit c8a64e2)

* Describe fixtures dir in the codebase overview (#9516)

* Describe fixtures dir in overview

* Fix folder name

(cherry picked from commit d12c41c)

* adds indirect refs to docs (#9528)

* adds indirect refs to docs

* Add more info

* Explain clearer

* Rephrase

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

* Update refs-and-the-dom.md

(cherry picked from commit 14fa8a5)

* Add reference to the Hyperscript libraries (#9517)

* Add reference to the Hyperscript libraries

I feel these should be mentioned as they provide terser syntax than using `R.createElement` directly, even with a shorthand.

* Rephrase

(cherry picked from commit a8c223a)

* [Docs] Fix confusing description for the <script>...</script> usage (#9502)

* Fix confusing description for the <script>...</script> usage

* Update jsx-in-depth.md

* Update reference-react-dom-server.md

* Update reference-react-dom.md

* Update reference-react.md

(cherry picked from commit 3d60d4c)

* [site] Load libraries from unpkg (#9499)

* [site] Load libraries from unpkg

* Revert Gemfile changes

(cherry picked from commit cf24d87)

* fixed error formatting in live editor (#9497)

(cherry picked from commit 7ccfb07)

* React.createElement syntax (#9459)

* React.createElement syntax

Added React.createElement syntax.
I think this is required for this tutorial.

* Reword

(cherry picked from commit 9824d52)

* Add guide on integrating with non-react code (#9316)

* Add guide on integrating with non-react code

* Capitalize guide title

* Make links to other docs relative

* Rephrase 'What it does do'

* Remove experimental syntax

* Capitalize Backbone

* Remove empty lifecycle method in generic jQuery example

* Use shouldComponentUpdate() not componentWillUpdate()

* Prefer single quotes

* Add cleanup to generic jQuery example

* Capitalize React

* Generalize the section on Backbone Views

* Generalize the section on Backbone Models, a little

* Add introduction

* Adjust wording

* Simplify ref callbacks

* Fix typo in generic jQuery example

* Fix typos in Backbone models in React components

* Fix more typos in Backbone models in React components

* Add generic section on integrating with other view libraries

* Stress the benefits of an unchanging React element

* Small changes to introduction

* Add missing semicolon

* Revise generic jQuery wrapper section

Moved the section on using empty elements to prevent conflicts above the
code example and added brief introduction to that example.

* Add usage example for Chosen wrapper

* Prevent Chosen wrapper from updating

* Note that sharing the DOM with plugins is not recommended

* Mention how React is used at Facebook

* Mention React event system in template rendering section

* Remove destructuring from function parameters

* Do not name React components Component

* Elaborate on unmountComponentAtNode()

* Mention preference for unidirectional data flow

* Rename backboneModelAdapter

* Replace rest syntax

* Respond to updated model in connectToBackboneModel

* Rewrite connectToBackboneModel example

* Rework connectToBackboneModel example

* Misc changes

* Misc changes

* Change wording

* Tweak some parts

(cherry picked from commit 1816d06)

* Don't build gh-pages branch on CircleCI (#9442)
flarnie added a commit that referenced this issue Jun 12, 2017
@flarnie
Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (#9472
4a91038 
)

This should have been retained in our docs, since PropTypes are only
moved and not deprecated.

Partially handles #9467, and I'll make a separate PR to
https:/reactjs/prop-types to add more docs to the README
there.
(cherry picked from commit 39ca8aa)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@flarnie flarnie

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bvaughn @gaearon @flarnie