1
0
Fork 0

fix(docs): Tutorials updates and corrections

This commit is contained in:
Benjamin F 2022-12-29 06:25:01 -08:00
parent 1634f986c4
commit dcb4b17032
23 changed files with 117 additions and 94 deletions

View file

@ -45,7 +45,7 @@ This change will also get picked up by the development environment, and you'll n
![This screen tells you that you are missing some required measurements](./required-measurements.png)
Since it's just one measurement, let's simply enter a value by hand.
For example `38` as 38cm is a realistic head circumference measurement for a baby.
For example `38` as 38 cm is a realistic head circumference measurement for a baby.
Enter `38` in the box, and click on **Draft Design** in the sidebar under the **View** heading.
This brings you back to our work in progress:

View file

@ -151,7 +151,7 @@ function draftBib({
*
* We're using increments of 1 degree
* until the `tipRightBottomStart` point
* is 1mm beyond the center of our bib.
* is 1 mm beyond the center of our bib.
*/
while (points.tipRightBottomStart.x > -1) {
for (const p of rotateThese) points[p] = points[p].rotate(1, points.edgeLeft)

View file

@ -55,7 +55,7 @@ Snippets are little re-useable things to embellish your pattern with.
Things like buttons or buttonholes, a logo, or snaps.
To use them, much like points and paths, we need to destructure both
the `Snippet` constructure as well as the `snippets` object to hold
the `Snippet` constructor as well as the `snippets` object to hold
our snippets:
```mjs

View file

@ -9,7 +9,7 @@ that is the `head` measurements multiplied by the `neckRatio` option.
That might involve some trial and error. But since the neck opening will be symmetric
both horizontal and vertical, we only need to construct one quadrant.
## Desructuring measurements and options
## Destructuring measurements and options
We'll be adding some points to our pattern to do just that. But we want to have
access to our measurements and options to do so. For this, we first destructure

View file

@ -21,7 +21,7 @@ does.
If you're not familiar with the `({ part })` syntax you see above, this is a
technique called *parameter destructuring* or more generally, [object
desctructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)
destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)
The draft method receives only 1 parameter: An object that holds everything you
need to draft your method. Destructuring is a way to *pull things out of the

View file

@ -9,7 +9,7 @@ and create one single path that follows our bib outline.
And as we now have one path to draw the bib, we can (and should)
remove the earlier paths we drew to see what we are doing.
The `round` macro we added earlier is still required to calcuate the points we
The `round` macro we added earlier is still required to calculate the points we
need to construct the half-circle. But we don't want it to draw the half-circle
path. As it happens, that is the default behaviour, so we merely have to remove
it's `hidden: false` property.

View file

@ -232,10 +232,10 @@ FreeSewing is a JavaScript library that can run in the browser, on
[Node.js](https://nodejs.org/), or a variety of other runtimes such as Deno,
AWS Lambda, and so on.
For development, we'll use NodeJS. If you don't have Node.js on your system,
For development, we'll use Node.js. If you don't have Node.js on your system,
follow the link above and install it on your system.
<Tip compact>You need NodeJS 16 or higher to use FreeSewing</Tip>
<Tip compact>You need Node.js 16 or higher to use FreeSewing</Tip>
When you're done, you can test whether it works by running:
@ -243,4 +243,4 @@ When you're done, you can test whether it works by running:
node -v
```
If you get the node version number, you're all set.
If you get the Node.js version number, you're all set.

View file

@ -68,7 +68,7 @@ If the delta is negative, our path is too short and we increase the tweak
factor.
We keep on doing this until `Math.abs(delta)` is less than 1. Meaning that we
are within 1mm of our target value.
are within 1 mm of our target value.
Now that we're happy with the length of our quarter neck opening, let's
construct the entire neck opening.

View file

@ -20,16 +20,16 @@ If you'd like to learn about those other files and folders, here's what they do:
- `lab`: Holds [React][react] hooks and components specific to the development environment
- `node_modules`: Holds installed dependencies
- `pages`: Holds [NextJS][next] client-side routes, aka pages
- `public`: Holds pregenerated translation files
- `public`: Holds pre-generated translation files
- `shared`: Holds files from FreeSewing's shared codebase for frontend development
### files
- `next.config.mjs`: The [NextJS][next] configuration file
- `next-i18next.config.js`: The configuration file for [next-i18next][i81n] which handles translation within NextJS
- `package.json`: Every NodeJS project has a [package.json][pkg] file which holds important metadata and lists dependencies
- `package.json`: Every Node.js project has a [package.json][pkg] file which holds important metadata and lists dependencies
- `package-lock.json`: This *lockfile* will only exist if you use the npm package manager
- `postcss.config.js`: Configuration file for [PostCSS][postcss], a tool to transform CSS with Javascript
- `postcss.config.js`: Configuration file for [PostCSS][postcss], a tool to transform CSS with JavaScript
- `tailwind.config.js`: Configuration file for the [TailwindCSS][tailwind] framework
- `yarn.lock`: This *lockfile* will only exist if you use [the yarn package manager][yarn]

View file

@ -70,7 +70,7 @@ option](test-option-neckratio.png)
### widthRatio
The `widthRatio` option will determine the width of our bib. For a the same
The `widthRatio` option will determine the width of our bib. For the same
`head` measurement, varying this option should result in increasingly wider
bibs.
@ -133,7 +133,7 @@ somehow his suit still fits.
The purpose of the antperson test is to bring out areas in your pattern where
you made assumptions that will not properly scale. Many drafting books will
tell you to _add 3cm there_ or _measure 2 inch to the right_. Those
tell you to _add 3 cm there_ or _measure 2 inch to the right_. Those
instructions don't scale, and you should avoid them.
The best patterns will pass the antperson test with 2 patterns exactly the