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

Do another pass at README / User Guide for 2.x #5127

Closed
gaearon opened this issue Sep 27, 2018 · 15 comments
Closed

Do another pass at README / User Guide for 2.x #5127

gaearon opened this issue Sep 27, 2018 · 15 comments

Comments

@gaearon
Copy link
Contributor

gaearon commented Sep 27, 2018

For example see #5103 (comment). We should just re-read the whole thing. Also possibly add link to 1.x version of User Guide at the top.

@gaearon gaearon added this to the 2.0.0 milestone Sep 27, 2018
@gaearon
Copy link
Contributor Author

gaearon commented Sep 27, 2018

@gaearon
Copy link
Contributor Author

gaearon commented Sep 27, 2018

@gaearon
Copy link
Contributor Author

gaearon commented Sep 27, 2018

@mareksuscak
Copy link
Contributor

Documented SVGs as React components in #5147.

@ArmanNisch
Copy link

ArmanNisch commented Sep 28, 2018

It also seems like the Configuring the Proxy Manually (line 1098) is not updated to the new way of configuring advanced proxies (i.e. CRA 2.0 now makes use of setupProxy.js)

@ArmanNisch
Copy link

There might be a duplication of information or at the very least the two below listed headings should probably be shown next to each other, as in my opinion, they both convey information relating to the same topic:

Line 833: The environment variables are embedded during the build time

Line 2047: Customizing Environment Variables for Arbitrary Build Environments

@mareksuscak
Copy link
Contributor

It also seems like the Configuring the Proxy Manually (line 1098) is not updated to the new way of configuring advanced proxies (i.e. CRA 2.0 now makes use of setupProxy.js)

The guide has recently been updated but lives in the next branch, all links point to master (URLs are not relative, can we make them be relative?)

You can find the updated section here.

@Timer
Copy link
Contributor

Timer commented Sep 28, 2018

next is no longer kept up to date. All changes are in master.

It also seems like the Configuring the Proxy Manually (line 1098) is not updated to the new way of configuring advanced proxies (i.e. CRA 2.0 now makes use of setupProxy.js)

This is updated. You must be looking at an old version?

@gaearon
Copy link
Contributor Author

gaearon commented Sep 28, 2018

#4903 (comment)

@gaearon
Copy link
Contributor Author

gaearon commented Sep 28, 2018

Should also document #5140

@gaearon
Copy link
Contributor Author

gaearon commented Sep 28, 2018

#5103 (comment)

@gaearon
Copy link
Contributor Author

gaearon commented Oct 1, 2018

#5144 (comment)

@gaearon
Copy link
Contributor Author

gaearon commented Oct 1, 2018

#5185

@Timer
Copy link
Contributor

Timer commented Oct 1, 2018

TODO:


#5103 (comment)

Updated

#4302 (comment)

Added extra release note to migration guide in #5103. Original documentation for this feature is still in our user guide.

#3644 (comment)

Added docs in e85019f

#4903 (comment)

Edited docs in b5bae25

#5103 (comment)
#5185

Added docs in df98c0c

@Timer
Copy link
Contributor

Timer commented Oct 1, 2018

Filed #5186, #5187 and #5188 for remaining follow ups and associated them with correct milestone.

@Timer Timer closed this as completed Oct 1, 2018
@lock lock bot locked and limited conversation to collaborators Jan 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants