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

New Docs #7864

Closed
wants to merge 119 commits into from
Closed

New Docs #7864

wants to merge 119 commits into from

Conversation

gaearon
Copy link
Collaborator

@gaearon gaearon commented Oct 4, 2016

We are currently working on a revamp of the docs.
This means we won’t be able to review new PRs to docs for two weeks until we ship this.

This PR is used to keep track of the overall effort.

TODO:

  • Write the new docs (team members, feel free to add your own todos here)
  • Find a place for refs, dangerouslySetInnerHTML
  • Explain Development vs Production versions
  • Add "How to Import" to top-level references, explaining import vs require vs global for React, ReactDOM and ReactDOMServer
  • Choose a single call to action on the homepage or make them different enough @lacker
  • Cross-reference docs
  • Consider embedding Codepen snippets everywhere
  • Remove extra vertical spacing between items in the sidebar
  • Remove temporary folder names (e.g. docs-new) and fix permalinks
  • Use babel-standalone instead of babel-browser everywhere ([docs] Use react-standalone #7668)
  • Set up redirects to handle all 404s gracefully
  • Be consistent in using const
  • Change "Codepen" to "CodePen" everywhere and consistently use a tags
  • Update examples in repo

Kevin Lacker and others added 3 commits October 3, 2016 14:40
Moving both "Community Resources" and "Support" into one tab called "Community"

* community tab exists

* make a community tab

* fix next link

* move urls to /community/

* refactor sidebars to be a bit more DRY

* fix names of files

* make the highlighty thing work

* move files to logical names

* also move translations
gaearon and others added 2 commits October 4, 2016 17:36
Combine "download" and "getting started" into one new "Installation" page.

* more installation instructions

* cdn instructions

* fix wording

* create-react-app -> Create React App

* new -> single page

* fix npm install instructions

* break out single html file into its own file

* another sentence

* use babel standalone

* enabling es6 and jsx

* remove old getting started
ericnakagawa and others added 4 commits October 20, 2016 10:41
[New Docs] Added: Lists & Conditional Rendering & Forms
* remove old docs framey stuff

* css tweak, tutorial rename, scrap old stuff

* fix the tutorial links

* broken link

* a slew of broken links

* all broken links up to the tips

* redirects for all the tips

* fix up prev/next links

* fix error decoder

* remove old folder

* move addons to reference

* Split Lists and Conditional Rendering (#2)

* Split Lists and Conditional Rendering

* Update lists-and-keys.md

* move around some redirects

* point to hello world rather than installation

* tweak hello world text

* make docs header point to hello world
@gaearon gaearon changed the title [WIP] New Docs New Docs Oct 21, 2016
@gaearon
Copy link
Collaborator Author

gaearon commented Oct 21, 2016

Merged via 455d2d1.

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

Successfully merging this pull request may close these issues.

9 participants