From e35bda36f79e34448969febe3134108d0bc546b3 Mon Sep 17 00:00:00 2001 From: joostdecock Date: Mon, 30 Oct 2023 19:27:24 +0100 Subject: [PATCH] chore(markdown): Changes to refer less to models --- .../dev/guides/best-practices/use-percentages/en.md | 8 ++++---- markdown/dev/howtos/environments/nodejs/en.md | 8 ++------ markdown/dev/reference/api/pattern/addpart/en.md | 12 ++++++++---- markdown/dev/reference/api/pattern/draft/en.md | 12 ++++++++---- markdown/dev/reference/api/pattern/getconfig/en.md | 7 +------ markdown/dev/reference/api/pattern/render/en.md | 12 ++++++++---- markdown/dev/reference/api/pattern/sample/en.md | 10 ++++++++-- .../reference/api/pattern/samplemeasurement/en.md | 12 ++++++++---- .../dev/reference/api/pattern/samplemodels/en.md | 10 ++++++++-- .../dev/reference/api/pattern/sampleoption/en.md | 12 ++++++++---- markdown/dev/reference/api/pattern/use/en.md | 12 ++++++++---- markdown/dev/reference/packages/snapseries/en.md | 2 +- markdown/dev/reference/plugins/timing/en.md | 13 ++++++++----- markdown/org/docs/designs/breanna/options/en.md | 4 ++-- markdown/org/docs/designs/brian/options/en.md | 4 ++-- markdown/org/docs/measurements/highbust/en.md | 3 ++- 16 files changed, 86 insertions(+), 55 deletions(-) diff --git a/markdown/dev/guides/best-practices/use-percentages/en.md b/markdown/dev/guides/best-practices/use-percentages/en.md index eefe1c6919d..211bd3cf5ec 100644 --- a/markdown/dev/guides/best-practices/use-percentages/en.md +++ b/markdown/dev/guides/best-practices/use-percentages/en.md @@ -19,11 +19,11 @@ and continue to work as the measurements scale up or down. ##### Use the doll and giant tests To check how well your pattern scales, you can -use the _doll_ and _giant_ tests by sampling the pattern for 3 models: +use the _doll_ and _giant_ tests by sampling the pattern for 3 measurements sets: -1. A model with measurements of an average person (the person) -2. A model with measurements 1/10th of an average person (the doll) -3. A model with measurements 3 times that of an average person (the giant) +1. A set of measurements from an average person (the person) +2. A set of measurements 1/10th of an average person (the doll) +3. A set of measurements 3 times that of an average person (the giant) A well-designed pattern will scale a factor 10 down or 3 up and still hold its shape. If your pattern makes assumptions about size, these tests will show that. diff --git a/markdown/dev/howtos/environments/nodejs/en.md b/markdown/dev/howtos/environments/nodejs/en.md index 5cb3e3d9261..f328f1ba407 100644 --- a/markdown/dev/howtos/environments/nodejs/en.md +++ b/markdown/dev/howtos/environments/nodejs/en.md @@ -67,7 +67,7 @@ console.log(svg) - We are using `@freesewing/aaron` as the design, but you could use any design - You probably want to [use your own measurements](/reference/settings/measurements) - or you could use `@freesewing/models` to load measurements from [our sizing grid](https://freesewing.org/sizes/) + or you could use [our curated measurements sets](https://freesewing.org/curated-sets) to load measurements. - We are using `@freesewing/plugin-theme` to theme our SVG, but you could [pass in your own CSS](/reference/api/svg/style) @@ -82,7 +82,6 @@ Obviously you need Node.js, but you will also need the following packages: - `@freesewing/plugin-bundle`: Set of common plugins - `@freesewing/aaron` or any design you want to use - Any design on which the design you choose is built. In this case, Aaron depends on `@freesewing/brian` -- `@freesewing/utils` For the example above, your `package.json` **dependencies** section will look like this: @@ -91,9 +90,6 @@ For the example above, your `package.json` **dependencies** section will look li "@freesewing/core": "latest" "@freesewing/aaron": "latest", "@freesewing/brian": "latest", - "@freesewing/models": "latest", - "@freesewing/plugin-bundle": "latest", - "@freesewing/plugin-theme": "latest", - "@freesewing/utils": "latest" + "@freesewing/plugin-theme": "latest" } ``` diff --git a/markdown/dev/reference/api/pattern/addpart/en.md b/markdown/dev/reference/api/pattern/addpart/en.md index 0ca66da0abe..ece42d850e1 100644 --- a/markdown/dev/reference/api/pattern/addpart/en.md +++ b/markdown/dev/reference/api/pattern/addpart/en.md @@ -17,7 +17,6 @@ Pattern pattern.addPart(object part) ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" const extra = { name: 'aaron.extra', @@ -36,9 +35,14 @@ const extra = { } } -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}).addPart(extra) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }).addPart(extra) const svg = pattern.draft().render() ``` diff --git a/markdown/dev/reference/api/pattern/draft/en.md b/markdown/dev/reference/api/pattern/draft/en.md index 4e5a34d142c..9d7b3d636bb 100644 --- a/markdown/dev/reference/api/pattern/draft/en.md +++ b/markdown/dev/reference/api/pattern/draft/en.md @@ -19,11 +19,15 @@ Pattern pattern.draft() ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }) const svg = pattern.draft().render() ``` diff --git a/markdown/dev/reference/api/pattern/getconfig/en.md b/markdown/dev/reference/api/pattern/getconfig/en.md index 978cabc0737..3aef886cc98 100644 --- a/markdown/dev/reference/api/pattern/getconfig/en.md +++ b/markdown/dev/reference/api/pattern/getconfig/en.md @@ -22,11 +22,6 @@ object pattern.getConfig() ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}) - -const config = pattern.getConfig() +const config = new Aaron().getConfig() ``` diff --git a/markdown/dev/reference/api/pattern/render/en.md b/markdown/dev/reference/api/pattern/render/en.md index b03faa5ad83..d21023a4bb6 100644 --- a/markdown/dev/reference/api/pattern/render/en.md +++ b/markdown/dev/reference/api/pattern/render/en.md @@ -16,11 +16,15 @@ string pattern.render() ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }) const svg = pattern.draft().render() ``` diff --git a/markdown/dev/reference/api/pattern/sample/en.md b/markdown/dev/reference/api/pattern/sample/en.md index 0a913110e93..fbb18f7c58a 100644 --- a/markdown/dev/reference/api/pattern/sample/en.md +++ b/markdown/dev/reference/api/pattern/sample/en.md @@ -35,11 +35,17 @@ Pattern pattern.sample() ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult } from "@freesewing/models" + +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements const pattern = new Aaron({ sample: { - models: cisFemaleAdult + models: measurements } }) diff --git a/markdown/dev/reference/api/pattern/samplemeasurement/en.md b/markdown/dev/reference/api/pattern/samplemeasurement/en.md index f79fc4556ce..a9900d66b7b 100644 --- a/markdown/dev/reference/api/pattern/samplemeasurement/en.md +++ b/markdown/dev/reference/api/pattern/samplemeasurement/en.md @@ -25,11 +25,15 @@ Pattern pattern.sampleMeasurement(string measurement) ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }) const svg = pattern.draft().sampleMeasurement('chest') ``` diff --git a/markdown/dev/reference/api/pattern/samplemodels/en.md b/markdown/dev/reference/api/pattern/samplemodels/en.md index 4a908743f01..c25195b6492 100644 --- a/markdown/dev/reference/api/pattern/samplemodels/en.md +++ b/markdown/dev/reference/api/pattern/samplemodels/en.md @@ -53,9 +53,15 @@ identifying your model in the models object. ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult } from "@freesewing/models" const Aaron = new Aaron() -const svg = aaron.sampleModels(cisFemaleAdult, "34").render() +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const svg = aaron.sampleModels(measurements, "34").render() ``` diff --git a/markdown/dev/reference/api/pattern/sampleoption/en.md b/markdown/dev/reference/api/pattern/sampleoption/en.md index a7efc51b289..557e889bcde 100644 --- a/markdown/dev/reference/api/pattern/sampleoption/en.md +++ b/markdown/dev/reference/api/pattern/sampleoption/en.md @@ -32,11 +32,15 @@ Pattern pattern.sampleOption(string option) ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }) const svg = pattern.draft().sampleOption('backlineBend') ``` diff --git a/markdown/dev/reference/api/pattern/use/en.md b/markdown/dev/reference/api/pattern/use/en.md index ee7318896e7..963d0ab8132 100644 --- a/markdown/dev/reference/api/pattern/use/en.md +++ b/markdown/dev/reference/api/pattern/use/en.md @@ -23,12 +23,16 @@ you plugin object. ```js import { Aaron } from "@freesewing/aaron" -import { cisFemaleAdult34 } from "@freesewing/models" import { pluginTheme } from "@freesewing/plugin-theme" -const pattern = new Aaron({ - measurements: cisFemaleAdult34 -}).use(pluginTheme) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }).use(pluginTheme) const svg = pattern.draft().render() ``` diff --git a/markdown/dev/reference/packages/snapseries/en.md b/markdown/dev/reference/packages/snapseries/en.md index 4acd9f4ea6e..36957d19933 100644 --- a/markdown/dev/reference/packages/snapseries/en.md +++ b/markdown/dev/reference/packages/snapseries/en.md @@ -2,7 +2,7 @@ title: snapseries --- -Published as [@freesewing/models][1], this package provides series +Published as [@freesewing/snapseries][1], this package provides series of common sizes for elastics and zippers and series of common intervals to be used with snapped percentage options. diff --git a/markdown/dev/reference/plugins/timing/en.md b/markdown/dev/reference/plugins/timing/en.md index 54f62cc05e1..8b97237fe2d 100644 --- a/markdown/dev/reference/plugins/timing/en.md +++ b/markdown/dev/reference/plugins/timing/en.md @@ -63,13 +63,16 @@ and the values are ```js import { Aaron } from '@freesewing/aaron' -import { cisFemaleAdult34 } from "@freesewing/models" import { pluginTiming } from '@freesewing/plugin-timing' -const pattern = new Aaron({ - measurements: cisFemaleAdult34, -}) - .use(pluginTiming) +// Load some public test measurements from the FreeSewing backend +const measurements = ( + await ( + await fetch("https://backend3.freesewing.org/curated-sets/1.json") + ).json() +).measurements + +const pattern = new Aaron({ measurements }).use(pluginTiming) const svg = pattern.draft().render() diff --git a/markdown/org/docs/designs/breanna/options/en.md b/markdown/org/docs/designs/breanna/options/en.md index 570fffdba16..d532a18a051 100644 --- a/markdown/org/docs/designs/breanna/options/en.md +++ b/markdown/org/docs/designs/breanna/options/en.md @@ -38,14 +38,14 @@ there to fit the shoulder. The width of the sleevecap (and thus the width of the sleeve at the bottom of the armhole) is equal to the distance between points 1 and 2. That distance depends on the measurements -of the model, the amount of ease, the cut of the garment and so on. For our sleevecap, all we +used, the amount of ease, the cut of the garment and so on. For our sleevecap, all we need to know is that we start with a given width. And while that width can be influenced by other factors, we can not influence it by any of the sleevecap options. ![Controlling the top of the sleevecap](sleevecaptop.svg) The height of the sleevecap is equal to the distance between points 3 and 4. The exact height -is a trade-off between the measurments of the model, options, ease, sleevecap ease, and the fact +is a trade-off between the measurements used, options, ease, sleevecap ease, and the fact that the sleeve ultimately has to fit the armhole. So the height may vary, and we don't control the exact value. But there are two options that control the shape of our sleevecap: diff --git a/markdown/org/docs/designs/brian/options/en.md b/markdown/org/docs/designs/brian/options/en.md index fad5429db08..7a6814690ae 100644 --- a/markdown/org/docs/designs/brian/options/en.md +++ b/markdown/org/docs/designs/brian/options/en.md @@ -38,14 +38,14 @@ there to fit the shoulder. The width of the sleevecap (and thus the width of the sleeve at the bottom of the armhole) is equal to the distance between points 1 and 2. That distance depends on the measurements -of the model, the amount of ease, the cut of the garment and so on. For our sleevecap, all we +used, the amount of ease, the cut of the garment and so on. For our sleevecap, all we need to know is that we start with a given width. And while that width can be influenced by other factors, we can not influence it by any of the sleevecap options. ![Controlling the top of the sleevecap](sleevecaptop.svg) The height of the sleevecap is equal to the distance between points 3 and 4. The exact height -is a trade-off between the measurments of the model, options, ease, sleevecap ease, and the fact +is a trade-off between the measurements used, options, ease, sleevecap ease, and the fact that the sleeve ultimately has to fit the armhole. So the height may vary, and we don't control the exact value. But there are two options that control the shape of our sleevecap: diff --git a/markdown/org/docs/measurements/highbust/en.md b/markdown/org/docs/measurements/highbust/en.md index 912ae93d578..4798898bd8d 100644 --- a/markdown/org/docs/measurements/highbust/en.md +++ b/markdown/org/docs/measurements/highbust/en.md @@ -4,7 +4,8 @@ title: High bust The **high bust** measurement is your chest circumference measured just under your arms, above the fullest part of your bust. -The point of the high bust measurement is to get an idea of the chest circumference without taking breasts into account. As such, this measurement is only relevant for models with breasts. +The point of the high bust measurement is to get an idea of the chest circumference without taking breasts into account. +As such, this measurement is most commonly used to fit people with breasts, but it's perfectly fine measurement for people without too. To measure your high bust, wrap the tape measure around your chest just under your arms. You might not be able to keep it horizontal (parallel to the floor), but that's ok.