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

chore: update link to developer documentation install page #1256

Merged
merged 2 commits into from
Jan 3, 2019
Merged

chore: update link to developer documentation install page #1256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f7cffe
chore: update link to developer documentation install page
awentzel Jan 2, 2019
3c561bc
update for minor edits to documentation
awentzel Jan 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ FAST-DNA is a mono repository managed with [Lerna](https://github.com/lerna/lern

## Documentation

Check out our [developer documentation](https://microsoft.github.io/fast-dna/docs/readme) to get started.
Check out our [developer documentation](https://microsoft.github.io/fast-dna/docs/en/contributing/install) to get started.

## Contact

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Clone the repository, `cd` into the project, install [Lerna](https://github.com/
```shell
git clone https://github.com/Microsoft/fast-dna.git
cd fast-dna
npm i --global lerna@3.3.0
npm i --global lerna
awentzel marked this conversation as resolved.
Show resolved Hide resolved
npm i
```

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ These may include:

All packages use npm and are published to the [npm registry](https://www.npmjs.com/).

### "sideEffects": false
### Side effects
awentzel marked this conversation as resolved.
Show resolved Hide resolved

All packages are expected to be side-effect free. Adding a `"sideEffects": false` flag to the package.json indicates to tools like webpack that the package's modules have no side effects (on evaluation) and only expose exports. This allows these tools to optimize re-exports through tree-shaking and dead code removal.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/contributing/standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Accessibility is acknowledged from the start of each new feature and must be add
* Some users with vestibular disorders or other cognitive disabilities have problems with movement. A safe fallback for nearly all users is fade animations.
* Avoid flashing animations can cause seizures or discomfort.

## JSS (JavaScript Style Sheets) usage
## JSS usage

JSS class names interfaces follow a [BEM-like](http://getbem.com/naming/) convention but our implementation of BEM is slightly modified because dashes — the character used to delimit *modifiers* — cannot be used as JavaScript object keys without using string literals; we use underscores instead. A single underscore separates an element from a block while two underscores separate a modifier from a block or element.
JSS (JavaScript Style Sheets) class names interfaces follow a [BEM-like](http://getbem.com/naming/) convention but our implementation of BEM is slightly modified because dashes — the character used to delimit *modifiers* — cannot be used as JavaScript object keys without using string literals; we use underscores instead. A single underscore separates an element from a block while two underscores separate a modifier from a block or element.

Example:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/contributing/working.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The above outlines the format for the **final** commit, but contributors have ma

Typical interim commits may look like the following:

```terminal
```bash
awentzel marked this conversation as resolved.
Show resolved Hide resolved
5ba3db6 update toggle markup for accessibility
84564a0 add border styles
887815f remove toggle underline on hover
Expand Down