Skip to content

Commit 215cdac

Browse files
authored
CONTRIBUTING.md: minor, capitalization, typo (npm#282)
1 parent 6f5d0c7 commit 215cdac

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ contribute a change? Great!
1616

1717
## Quick start
1818

19-
1. `npm install` to download gatsby, our theme, and the dependencies
19+
1. `npm install` to download Gatsby, our theme, and the dependencies
2020
2. `npm run develop`: starts the test server at `http://localhost:8000`.
21-
3. Update the content - it's Mdx, which is like markdown - in the `content`
21+
3. Update the content - it's MDX, which is like markdown - in the `content`
2222
directory.
2323
4. Review your content at `http://localhost:8000`. (Gatsby watches the
2424
filesystem and will reload your content changes immediately.)
@@ -30,10 +30,10 @@ contribute a change? Great!
3030

3131
## Running locally
3232

33-
First, `npm install` the dependencies. This will install gatsby, et al.
33+
First, `npm install` the dependencies. This will install Gatsby, et al.
3434

3535
Next, `npm run develop` to start the test server to view your changes.
36-
The gatsby server will be started on port 8000. You can navigate to
36+
The Gatsby server will be started on port 8000. You can navigate to
3737
`http://localhost:8000` to view the site live.
3838

3939
**For best results use npm 8**
@@ -46,7 +46,7 @@ changes you make should be reflected in the site immediately.
4646
### Documentation content
4747

4848
The documentation content lives in the `content` directory, and is
49-
markdown. (Actually, [Mdx](https://mdxjs.com/), a sort of reactive
49+
markdown. (Actually, [MDX](https://mdxjs.com/), a sort of reactive
5050
markdown.)
5151

5252
### Static content (images)
@@ -55,7 +55,7 @@ Static content lives in the `static` directory. Since most of the
5555
static content is screenshots, you can use the `Screenshot` component
5656
to reference them, which is an extension of the `Img` component that
5757
is configured for the docs site. For example, an image living as
58-
`static/organizations/managing-temas/team-members.png` would be
58+
`static/organizations/managing-teams/team-members.png` would be
5959
referenced as:
6060

6161
```
@@ -69,7 +69,7 @@ referenced as:
6969
There are various places where we want to share content between
7070
pages, to prevent copy-pasta. For example, we display a screenshot
7171
of the user login dialog repeatedly. Therefore this shared content
72-
is defined in `src/shared.js`, and includes a literal Mdx snippet.
72+
is defined in `src/shared.js`, and includes a literal MDX snippet.
7373

7474
For example, `user-login` is defined with `text` and `image`
7575
properties:
@@ -83,7 +83,7 @@ m login dialog" />)
8383
},
8484
```
8585

86-
Since Mdx is reactive, you can import the shared data at the top of the
86+
Since MDX is reactive, you can import the shared data at the top of the
8787
file, just beneath your frontmatter:
8888

8989
```
@@ -222,7 +222,7 @@ On step three, your changes will be published live! 🎉
222222

223223
## Theme
224224

225-
The gatsby theme used here is located in the [`theme/`](./theme) directory. It is a variation of
225+
The Gatsby theme used here is located in the [`theme/`](./theme) directory. It is a variation of
226226
[doctocat](https://github.com/primer/doctocat) with some theme changes
227227
for npm's design language and additional components to support multiple
228-
versions of the CLI documentation.
228+
versions of the CLI documentation.

0 commit comments

Comments
 (0)