[docs] Fix inconsistencies

oliviertassinari · Dec 1, 2017 · 2dc1bd7 · 2dc1bd7
1 parent c63a258
commit 2dc1bd7
Show file tree

Hide file tree

Showing 108 changed files with 244 additions and 151 deletions.
diff --git a/.firebaserc b/.firebaserc
@@ -1,5 +1,5 @@
 {
   "projects": {
-    "material-ui": "material-ui-1dab0"
+    "material-ui": "material-next"
   }
-}
+}
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -26,7 +26,7 @@
     Include code to reproduce, if relevant (which it most likely is).
 
     This codesandbox.io template _may_ be a good starting point:
-    https://codesandbox.io/s/github/material-next/material-next/tree/v1-beta/examples/create-react-app
+    https://codesandbox.io/s/github/material-next/material-next/tree/master/examples/create-react-app
 
 
     If YOU DO NOT take time to provide a codesandbox.io reproduction, should the COMMUNITY take time to help you?
@@ -47,9 +47,9 @@
 ## Your Environment
 <!--- Include as many relevant details about the environment with which you experienced the bug. -->
 
-| Tech         | Version |
-|--------------|---------|
-| Material-Next  |         |
-| React        |         |
-| browser      |         |
-| etc          |         |
+| Tech            | Version |
+|-----------------|---------|
+| @material-next/ |         |
+| React           |         |
+| browser         |         |
+| etc             |         |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,20 +10,20 @@ When in doubt, keep your pull requests small. To give a PR the best chance of ge
 
 As with issues, please begin the title with [ComponentName].
 
-When adding new features or modifying existing, please attempt to include tests to confirm the new behaviour. You can read more about our test setup [here](https://github.com/material-next/material-next/blob/v1-beta/test/README.md).
+When adding new features or modifying existing, please attempt to include tests to confirm the new behaviour. You can read more about our test setup [here](https://github.com/material-next/material-next/blob/master/test/README.md).
 
 ### Branch Structure
 
-All stable releases are tagged ([view tags](https://github.com/material-next/material-next/tags)). At any given time, `v1-beta` represents the latest development version of the library.
+All stable releases are tagged ([view tags](https://github.com/material-next/material-next/tags)). At any given time, `master` represents the latest development version of the library.
 Patches or hotfix releases are prepared on an independent branch.
 
-#### `v1-beta` is unsafe
+#### `master` is unsafe
 
-We will do our best to keep `v1-beta` in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with.
+We will do our best to keep `master` in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with.
 
 ## Getting started
 
-Please create a new branch from an up to date v1-beta on your fork. (Note, urgent hotfixes should be branched off the latest stable release rather than v1-beta)
+Please create a new branch from an up to date master on your fork. (Note, urgent hotfixes should be branched off the latest stable release rather than master)
 
 1. Fork the Material-Next repository on Github
 2. Clone your fork to your local machine `git clone git@github.com:<yourname>/material-ui.git`
@@ -34,8 +34,8 @@ Please create a new branch from an up to date v1-beta on your fork. (Note, urgen
 If you have an existing local repository, please update it before you start, to minimise the chance of merge conflicts.
 ```js
 git remote add upstream git@github.com:material-next/material-next.git
-git checkout v1-beta
-git pull upstream v1-beta
+git checkout master
+git pull upstream master
 git checkout -b my-topic-branch
 yarn
 ```
@@ -114,7 +114,7 @@ In case you missed something, [we have a real example that can be used as a summ
 
 ## Roadmap
 
-To get a sense of where Material-Next is heading, or for ideas on where you could contribute, take a look at the [ROADMAP](https://github.com/material-next/material-next/blob/v1-beta/ROADMAP.md).
+To get a sense of where Material-Next is heading, or for ideas on where you could contribute, take a look at the [ROADMAP](https://github.com/material-next/material-next/blob/master/ROADMAP.md).
 
 ## License
 

diff --git a/README.md b/README.md
@@ -11,14 +11,12 @@ that you can use to tag your questions.
 [![CircleCI](https://img.shields.io/circleci/project/github/material-next/material-next/master.svg)](https://circleci.com/gh/material-next/material-next/tree/master)
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat-f81a65.svg)](https://gitter.im/callemall/material-ui?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Coverage Status](https://img.shields.io/codecov/c/github/material-next/material-next/master.svg)](https://codecov.io/gh/material-next/material-next/branch/master)
-[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1320/badge)](https://bestpractices.coreinfrastructure.org/projects/1320)
 
 [![PeerDependencies](https://img.shields.io/david/peer/material-next/material-next.svg)](https://david-dm.org/material-next/material-next#info=peerDependencies&view=list)
 [![Dependencies](https://img.shields.io/david/material-next/material-next.svg)](https://david-dm.org/material-next/material-next)
 [![DevDependencies](https://img.shields.io/david/dev/material-next/material-next.svg)](https://david-dm.org/material-next/material-next#info=devDependencies&view=list)
 
-> Material-Next is a set of [React](http://facebook.github.io/react/) components that implement
-[Google's Material Design](https://www.google.com/design/spec/material-design/introduction.html) specification.
+> Extensible [React](http://facebook.github.io/react/) components that implement [Material Design UI](https://material.io/).
 
 ## This is a fork
 
@@ -47,7 +45,7 @@ Here is a quick example to get you started, it's all you need:
 ```jsx
 import React from 'react';
 import { render } from 'react-dom';
-import Button from 'material-ui/Button';
+import Button from '@material-next/core/Button';
 
 function App() {
   return (

diff --git a/docs/README.md b/docs/README.md
@@ -10,5 +10,5 @@ npm run docs:dev
 
 ## How can I add a new demo in the documentation?
 
-[You can follow this guide](https://github.com/material-next/material-next/blob/v1-beta/CONTRIBUTING.md)
+[You can follow this guide](https://github.com/material-next/material-next/blob/master/CONTRIBUTING.md)
 on how to get started contributing to Material-Next.
diff --git a/docs/src/modules/components/AppFooter.js b/docs/src/modules/components/AppFooter.js
@@ -39,15 +39,13 @@ function AppFooter(props: Object) {
             <Grid item xs={12} sm={6}>
               <ul className={classes.list}>
                 <li className={classes.listItem}>
-                  <Link href="https://github.com/@material-next/core/@material-next/core/tree/v1-beta">
-                    GitHub
-                  </Link>
+                  <Link href="https://github.com/material-next/material-next">GitHub</Link>
                 </li>
                 <li className={classes.listItem}>
                   <Link href="https://twitter.com/MaterialNext">Twitter</Link>
                 </li>
                 <li className={classes.listItem}>
-                  <Link href="https://github.com/@material-next/core/@material-next/core/tree/v1-beta/examples">
+                  <Link href="https://github.com/material-next/material-next/tree/master/examples">
                     Examples
                   </Link>
                 </li>

diff --git a/docs/src/modules/components/AppFrame.js b/docs/src/modules/components/AppFrame.js
@@ -238,7 +238,7 @@ class AppFrame extends React.Component<any, any> {
               component="a"
               title="GitHub"
               color="contrast"
-              href="https://github.com/@material-next/core/@material-next/core/tree/v1-beta"
+              href="https://github.com/material-next/material-next"
             >
               <Github />
             </IconButton>

diff --git a/docs/src/modules/components/MarkdownDocs.js b/docs/src/modules/components/MarkdownDocs.js
@@ -25,8 +25,7 @@ const styles = {
 };
 
 const demoRegexp = /^demo='(.*)'$/;
-const SOURCE_CODE_ROOT_URL =
-  'https://github.com/@material-next/core/@material-next/core/tree/v1-beta';
+const SOURCE_CODE_ROOT_URL = 'https://github.com/material-next/material-next/tree/master';
 
 type InjectedProps = {
   classes: Object,

diff --git a/docs/src/modules/utils/generateMarkdown.js b/docs/src/modules/utils/generateMarkdown.js
@@ -5,8 +5,7 @@ import recast from 'recast';
 import kebabCase from 'lodash/kebabCase';
 import { pageToTitle } from './helpers';
 
-const SOURCE_CODE_ROOT_URL =
-  'https://github.com/@material-next/core/@material-next/core/tree/v1-beta';
+const SOURCE_CODE_ROOT_URL = 'https://github.com/material-next/material-next/tree/master';
 
 function generateHeader(reactAPI) {
   return ['---', `filename: ${reactAPI.filename}`, '---'].join('\n');

diff --git a/docs/src/pages/customization/overrides.md b/docs/src/pages/customization/overrides.md
@@ -31,7 +31,7 @@ When the `className` property isn't enough, and you need to access deeper elemen
 The list of  classes for each
 component is documented in the **Component API** section.
 For instance, you can have a look at the [Button CSS API](/api/button#css-api).
-Alternatively, you can always look at the [implementation details](https://github.com/material-next/material-next/blob/v1-beta/src/Button/Button.js).
+Alternatively, you can always look at the [implementation details](https://github.com/material-next/material-next/blob/master/src/Button/Button.js).
 
 This example also uses `withStyles()` (see above), but here, `OverridesClasses` is using Button's `classes` prop to
 provide an array containing the **names of classes to override** (keys), and the **CSS class names to apply** (values).

diff --git a/docs/src/pages/customization/themes.md b/docs/src/pages/customization/themes.md
@@ -78,7 +78,7 @@ You can make a theme dark by setting `type` to `dark`.
 ### The other variables
 
 We have tried to normalize the implementation by adding many more variables: typography, breakpoints, transitions, etc. You can see below what the theme object looks like with the default values.
-If you want to learn more, we suggesting having a look at [`material-ui/style/createMuiTheme.js`](https://github.com/material-next/material-next/blob/v1-beta/src/styles/createMuiTheme.js).
+If you want to learn more, we suggesting having a look at [`material-ui/style/createMuiTheme.js`](https://github.com/material-next/material-next/blob/master/src/styles/createMuiTheme.js).
 
 {{demo='pages/customization/ThemeDefault.js'}}
 
@@ -101,7 +101,7 @@ That's a really powerful feature.
 
 The list of these customization points for each component is documented under the **Component API** section.
 For instance, you can have a look at the [Button](/api/button#css-api).
-Alternatively, you can always have a look at the [implementation](https://github.com/material-next/material-next/blob/v1-beta/src/Button/Button.js).
+Alternatively, you can always have a look at the [implementation](https://github.com/material-next/material-next/blob/master/src/Button/Button.js).
 
 ## Accessing the theme in a component
 

diff --git a/docs/src/pages/discover-more/Team.js b/docs/src/pages/discover-more/Team.js
@@ -22,29 +22,29 @@ const members = [
     name: 'Olivier Tassinari',
     github: 'oliviertassinari',
     twitter: 'olivtassinari',
-    flag: 'co-creator',
+    flag: 'Co-creator',
     city: 'Paris, France',
   },
+  {
+    name: 'Nathan Marks',
+    github: 'nathanmarks',
+    flag: 'Co-creator',
+    city: 'Toronto, ON',
+  },
   {
     name: 'Matt Brookes',
     github: 'mbrookes',
     twitter: 'randomtechdude',
-    flag: 'Documentation wizard',
+    flag: 'Documentation wizard 📖',
     city: 'London, UK',
   },
   {
     name: 'Kevin Ross',
     github: 'rosskevin',
     twitter: 'rosskevin',
-    flag: 'Core focus, Flow',
+    flag: 'Core focus',
     city: 'Franklin, Tennessee, US',
   },
-  {
-    name: 'Nathan Marks',
-    github: 'nathanmarks',
-    flag: 'v1.x co-creator',
-    city: 'Toronto, ON',
-  },
   {
     name: 'Sebastian Sebald',
     github: 'sebald',

diff --git a/docs/src/pages/getting-started/example-projects.md b/docs/src/pages/getting-started/example-projects.md
@@ -2,13 +2,13 @@
 
 Are you looking for an example project to get started?
 
-We host some example projects which you can find in the [GitHub repository](https://github.com/material-next/material-next) under the [`/examples`](https://github.com/material-next/material-next/tree/v1-beta/examples) folder:
-- [Create React App](https://github.com/material-next/material-next/tree/v1-beta/examples/create-react-app)
-- [Next.js](https://github.com/material-next/material-next/tree/v1-beta/examples/nextjs)
-- [Create React App with Flow](https://github.com/material-next/material-next/tree/v1-beta/examples/create-react-app-with-flow)
-- [Create React App with TypeScript](https://github.com/material-next/material-next/tree/v1-beta/examples/create-react-app-with-typescript)
+We host some example projects which you can find in the [GitHub repository](https://github.com/material-next/material-next) under the [`/examples`](https://github.com/material-next/material-next/tree/master/examples) folder:
+- [Create React App](https://github.com/material-next/material-next/tree/master/examples/create-react-app)
+- [Next.js](https://github.com/material-next/material-next/tree/master/examples/nextjs)
+- [Create React App with Flow](https://github.com/material-next/material-next/tree/master/examples/create-react-app-with-flow)
+- [Create React App with TypeScript](https://github.com/material-next/material-next/tree/master/examples/create-react-app-with-typescript)
 
 The source code for this documentation site is also included in the repository.
 This is a slightly more complex project.
-Check out the [`/docs`](https://github.com/material-next/material-next/tree/v1-beta/docs) folder for
+Check out the [`/docs`](https://github.com/material-next/material-next/tree/master/docs) folder for
 build instructions.
diff --git a/docs/src/pages/getting-started/frequently-asked-questions.md b/docs/src/pages/getting-started/frequently-asked-questions.md
@@ -56,7 +56,7 @@ export default withTheme()(withStyles(styles)(Modal));
 ## Material-Next is awesome. How can I support the project?
 
 There are a lot of ways to support Material-Next:
-- Improve [the documentation](https://github.com/material-next/material-next/tree/v1-beta/docs).- Help others to get started.- [Spread the word](https://twitter.com/MaterialNext).- Answer [StackOverflow questions](https://stackoverflow.com/questions/tagged/material-ui).If you use Material-Next in a commercial project and would like to support its continued development by becoming a **Sponsor**,
+- Improve [the documentation](https://github.com/material-next/material-next/tree/master/docs).- Help others to get started.- [Spread the word](https://twitter.com/MaterialNext).- Answer [StackOverflow questions](https://stackoverflow.com/questions/tagged/material-ui).If you use Material-Next in a commercial project and would like to support its continued development by becoming a **Sponsor**,
 or in a side or hobby project and would like to become a backer, you can do so through [OpenCollective](https://opencollective.com/material-ui).
 
 All funds raised are managed transparently, and Sponsors receive recognition in the README and on the Material-Next home page.
diff --git a/docs/src/pages/getting-started/installation.md b/docs/src/pages/getting-started/installation.md
@@ -28,7 +28,5 @@ In order to use prebuilt SVG Material icons, such as those found in the [compone
 you must first install the [material-ui-icons](https://www.npmjs.org/package/material-ui-icons) package:
 
 ```
-npm install material-ui-icons
+npm install --save @material-ui/icons
 ```
-
-This package replaces the `svg-icons` previously included with Material-Next.
diff --git a/docs/src/pages/getting-started/usage.md b/docs/src/pages/getting-started/usage.md
@@ -13,7 +13,7 @@ Here is a quick example to get you started, **it's all you need**:
 ```jsx
 import React from 'react';
 import { render } from 'react-dom';
-import Button from 'material-ui/Button';
+import Button from '@material-next/core/Button';
 
 function App() {
   return (

diff --git a/docs/src/pages/guides/flow.md b/docs/src/pages/guides/flow.md
@@ -1,7 +1,7 @@
 # Flow
 
 You can add static typing to JavaScript to improve developer productivity and code quality thanks to [Flow](https://github.com/facebook/flow).
-Have a look at the [Create React App with Flow](https://github.com/material-next/material-next/tree/v1-beta/examples/create-react-app-with-flow) example.
+Have a look at the [Create React App with Flow](https://github.com/material-next/material-next/tree/master/examples/create-react-app-with-flow) example.
 
 ## Warning
 An [existing bug in flow regarding the use of higher order components (HOC)](https://github.com/facebook/flow/issues/5382)

diff --git a/docs/src/pages/guides/migration-v0.x.md b/docs/src/pages/guides/migration-v0.x.md
@@ -1,4 +1,4 @@
-# Migration from v0.x
+# Migration from Material-UI v0.x
 
 ## FAQ
 
@@ -48,14 +48,14 @@ then
 import FlatButton from 'material-ui/FlatButton'; // v0.x
 import Button from 'material-ui-next/Button'; // v1.x
 ```
-2. Run [the migration helper](https://github.com/material-next/material-next/tree/v1-beta/packages/material-ui-codemod) on your project.
+2. Run [the migration helper](https://github.com/material-next/material-next/tree/master/packages/material-ui-codemod) on your project.
 3. After that, you are free to migrate one component instance at the time.
 
 ## Components
 
 ### Svg Icon
 
-First, run [the migration helper](https://github.com/material-next/material-next/tree/v1-beta/packages/material-ui-codemod) on your project.
+First, run [the migration helper](https://github.com/material-next/material-next/tree/master/packages/material-ui-codemod) on your project.
 
 However, this might not be enough when using the svg icons.
 The `material-ui-icons` package has a dependency on the `masterial-ui/SvgIcon` module.