Skip to content

Commit 97bcb79

Browse files
authored
Merge pull request #713 from omahs/patch-1 - documentation typos fixed
Fix typos
2 parents 24675bb + 11b5866 commit 97bcb79

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you are here to edit or translate content, please do so inside [the `src/cont
1212
For making code changes, please check out the [technical overview](./docs/technical_overview.md) to get started.
1313

1414
### Adding Libraries
15-
Follow the steps in the <a href="./docs/contributing_libraries.md">Contributing Libraries</a> doc if you would like to add your libary to the collection!
15+
Follow the steps in the <a href="./docs/contributing_libraries.md">Contributing Libraries</a> doc if you would like to add your library to the collection!
1616

1717
## Add Yourself to p5.js Contributors
1818
We recognize all types of contributions. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Add yourself to the [p5.js repository readme](https://github.com/processing/p5.js/blob/main/README.md#contributors) by following the [instructions here](https://github.com/processing/p5.js/issues/2309)!

docs/localization.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Localization Architecture
22

3-
An important feature of the p5.js website is support multiple languages (four and counting!). This requires the website to build and serve every page in each of the supported languages.
3+
An important feature of the p5.js website is its support for multiple languages (four and counting!). This requires the website to build and serve every page in each of the supported languages.
44

55
Our website framework Astro has localization support, but it doesn't cover our full set of needs so the localization tooling in this repo is largely [hand rolled](https://www.quora.com/Computer-Science-Where-did-the-phrase-Roll-your-own-come-from-and-why-is-it-used-in-CS).
66

@@ -29,7 +29,7 @@ Taking the tutorials page as an example:
2929

3030
Both of these routes use the [TutorialsLayout](/src/layouts/TutorialsLayout.astro) to render the page by passing in the content in the correct language.
3131

32-
The main difference between these two routing files is how they retrieve the correct translation. The English version retreives the English version of the content. The other translations retrieve their version of the content and then fill in any gaps with English versions. See `getCollectionInLocaleWithFallbacks()` for how this works.
32+
The main difference between these two routing files is how they retrieve the correct translation. The English version retrieves the English version of the content. The other translations retrieve their version of the content and then fill in any gaps with English versions. See `getCollectionInLocaleWithFallbacks()` for how this works.
3333

3434
Because of this subtle duplication, we try to keep the files in `src/pages/` as short as possible and move rendering logic into the [layout files](/src/layouts/).
3535

@@ -89,7 +89,7 @@ const uiTranslations = await getUiTranslationWithFallback(currentLocale);
8989
9090
```
9191

92-
And then in the HelloButton Preact component, we acess the translations using object keys:
92+
And then in the HelloButton Preact component, we access the translations using object keys:
9393

9494
```jsx
9595
export const HelloButton = (props) => {
@@ -98,7 +98,7 @@ export const HelloButton = (props) => {
9898
};
9999
```
100100

101-
Essentially, the arguments you would pass to `t` in the first example for astro files are the same you would pass as keys to the `uiTranslations` object. If its a nested key, that looks like:
101+
Essentially, the arguments you would pass to `t` in the first example for astro files are the same you would pass as keys to the `uiTranslations` object. If it's a nested key, that looks like:
102102

103103
```jsx
104104
uiTranslations["sectionTitles"]["main"];

docs/styles_architecture.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ There are a few ways you can write CSS in this project:
66

77
### 1. Use [Tailwind](https://tailwindcss.com/) css classes directly within layouts and components
88

9-
This is often the fastest way to add custom styles if you are familair with [Tailwind](https://tailwindcss.com/). See a good example in `/src/p5/p5.js-website/src/components/Footer/index.astro`.
9+
This is often the fastest way to add custom styles if you are familiar with [Tailwind](https://tailwindcss.com/). See a good example in `/src/p5/p5.js-website/src/components/Footer/index.astro`.
1010

1111
### 2. Write styles in the [SCSS](https://sass-lang.com/) files in `/styles` and use those classes in layouts and components
1212

@@ -18,7 +18,7 @@ This can be useful for situations where the styling you need for a particular ar
1818

1919
#### 4. Write css in a style tag within an `.astro` file
2020

21-
This can be a good approach when you need a few custom styles for a single a layout or component but adding an extra SCSS feels like overkill. See an example in `/src/layouts/AboutLayout.astro`
21+
This can be a good approach when you need a few custom styles for a single layout or component but adding an extra SCSS feels like overkill. See an example in `/src/layouts/AboutLayout.astro`
2222

2323
## Useful Global Styles
2424

src/content/contributor-docs/en/README.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Head over to [this link](../contributor_guidelines/) where you will be guided on
5959

6060
Most of the time we will stick with this workflow quite strictly and, especially if you have contributed to other projects before, it may feel like there are too many hoops to jump through for what may be a simple contribution. However, the steps above are aimed to make it easy for you as a contributor and for stewards/maintainers to contribute meaningfully, while also making sure that you won't be spending time working on things that may not be accepted for various reasons. The steps above will help ensure that any proposals or fixes are adequately discussed and considered before any work begin, and often this will actually save you (and the steward/maintainer) time because the PR that would need additional fixing after review, or outright not accepted, would happen less often as a result.
6161

62-
**We see contributing to p5.js as a learning opportunity** and we don't measure sucess by only looking at the volume of contributions we received. There is no time limit on how long it takes you to complete a contribution, so take your time and work at your own pace (we may check in after a long period of inactivity). Ask for help from any of the stewards or maintainers if you need them and we'll try our best to support you. For information related to area stewards or general maintenance of p5.js GitHub repository, please check out the [steward guidelines](../steward_guidelines/).
62+
**We see contributing to p5.js as a learning opportunity** and we don't measure success by only looking at the volume of contributions we received. There is no time limit on how long it takes you to complete a contribution, so take your time and work at your own pace (we may check in after a long period of inactivity). Ask for help from any of the stewards or maintainers if you need them and we'll try our best to support you. For information related to area stewards or general maintenance of p5.js GitHub repository, please check out the [steward guidelines](../steward_guidelines/).
6363

6464
## Non-source code contribution
6565

0 commit comments

Comments
 (0)