From 24f777684030c4e8186a25b4167b79361fe6fcf5 Mon Sep 17 00:00:00 2001 From: Benjamin F Date: Thu, 22 Dec 2022 17:24:59 -0800 Subject: [PATCH] fix(docs): Howtos documentation corrections and updates --- markdown/dev/howtos/code/accessing-measurements/en.md | 7 ++++--- markdown/dev/howtos/code/accessing-options/en.md | 11 ++++++----- markdown/dev/howtos/code/adding-paths/en.md | 2 +- markdown/dev/howtos/code/adding-points/en.md | 2 +- markdown/dev/howtos/code/adding-snippets/en.md | 2 +- markdown/dev/howtos/code/adding-text/en.md | 1 - markdown/dev/howtos/code/after/en.md | 4 +++- markdown/dev/howtos/code/create-new-design/en.md | 8 ++++---- markdown/dev/howtos/code/hide-paths/en.md | 2 +- markdown/dev/howtos/code/text-whitespace/en.md | 2 +- markdown/dev/howtos/design/fit-sleeve/en.md | 6 +++--- markdown/dev/howtos/design/seam-allowance/en.md | 2 +- markdown/dev/howtos/editors/blogpost/en.md | 2 +- markdown/dev/howtos/editors/frontmatter/about/en.md | 2 +- markdown/dev/howtos/editors/frontmatter/en.md | 2 +- .../dev/howtos/editors/frontmatter/multi-line/en.md | 4 ++-- markdown/dev/howtos/editors/showcase/en.md | 2 +- markdown/dev/howtos/environments/browser/en.md | 4 ++-- markdown/dev/howtos/environments/nodejs/en.md | 2 +- .../dev/howtos/git/editing-content-on-github/en.md | 6 +++--- markdown/dev/howtos/git/en.md | 4 ++-- .../howtos/ways-to-contribute/develop-patterns/en.md | 2 +- markdown/dev/howtos/ways-to-contribute/devops/en.md | 2 +- .../ways-to-contribute/showcase-our-patterns/en.md | 6 +++--- .../ways-to-contribute/technical-writing/code/en.md | 2 +- 25 files changed, 46 insertions(+), 43 deletions(-) diff --git a/markdown/dev/howtos/code/accessing-measurements/en.md b/markdown/dev/howtos/code/accessing-measurements/en.md index cb480db37ad..31e96ae9aea 100644 --- a/markdown/dev/howtos/code/accessing-measurements/en.md +++ b/markdown/dev/howtos/code/accessing-measurements/en.md @@ -2,18 +2,19 @@ title: Accessing measurements --- -Measurements are available on the `measurements` key of from the object passed +[Measurements](/reference/measurements) are available on the `measurements` key of from the object passed to your part's draft method. You can destructure them for easy access. ```design/src/part.mjs function draftPart = ({ // highlight-start - measurements, + measurements, // highlight-end part }) { - // Do something here + const a = measurements.chest + const b = measurements['hips'] return part } diff --git a/markdown/dev/howtos/code/accessing-options/en.md b/markdown/dev/howtos/code/accessing-options/en.md index 409b7ed2165..76960327256 100644 --- a/markdown/dev/howtos/code/accessing-options/en.md +++ b/markdown/dev/howtos/code/accessing-options/en.md @@ -2,18 +2,19 @@ title: Accessing options --- -(the value of) Options are available on the `options` key of from the object +Options are available on the `options` key of from the object passed to your part's draft method. You can destructure them for easy access. ```design/src/part.mjs -function draftPart = ({ +function draftPart = ({ // highlight-start - options, + options, // highlight-end - part + part }) { - // Do something here + const a = options.fitKnee + const b = options[waistEase] return part } diff --git a/markdown/dev/howtos/code/adding-paths/en.md b/markdown/dev/howtos/code/adding-paths/en.md index 41e84cb75a7..0cf927bc01a 100644 --- a/markdown/dev/howtos/code/adding-paths/en.md +++ b/markdown/dev/howtos/code/adding-paths/en.md @@ -3,7 +3,7 @@ title: Adding paths --- Paths should be stored in the `paths` key of the object passed to your part's -draft method. The contructor for paths is available in the `Path` key. You can +draft method. The constructor for paths is available in the `Path` key. You can destructure them for easy access. diff --git a/markdown/dev/howtos/code/adding-points/en.md b/markdown/dev/howtos/code/adding-points/en.md index dbf8f31df7d..137f7d8bb23 100644 --- a/markdown/dev/howtos/code/adding-points/en.md +++ b/markdown/dev/howtos/code/adding-points/en.md @@ -3,7 +3,7 @@ title: Adding points --- Points should be stored in the `points` key of the object passed to your part's -draft method. The contructor for points is available in the `Point` key. You +draft method. The constructor for points is available in the `Point` key. You can destructure them for easy access. diff --git a/markdown/dev/howtos/code/adding-snippets/en.md b/markdown/dev/howtos/code/adding-snippets/en.md index d6cadb9edd1..e586a4139ee 100644 --- a/markdown/dev/howtos/code/adding-snippets/en.md +++ b/markdown/dev/howtos/code/adding-snippets/en.md @@ -3,7 +3,7 @@ title: Adding snippets --- Snippets should be stored in the `snippets` key of the object passed to your part's -draft method. The contructor for snippets is available in the `Snippets` key. You can +draft method. The constructor for snippets is available in the `Snippets` key. You can destructure them for easy access. diff --git a/markdown/dev/howtos/code/adding-text/en.md b/markdown/dev/howtos/code/adding-text/en.md index a5a69308a10..4f53dd5c2d8 100644 --- a/markdown/dev/howtos/code/adding-text/en.md +++ b/markdown/dev/howtos/code/adding-text/en.md @@ -37,4 +37,3 @@ function draftPart = ({ } ``` -``` diff --git a/markdown/dev/howtos/code/after/en.md b/markdown/dev/howtos/code/after/en.md index 551ab521f9b..f0771753ef6 100644 --- a/markdown/dev/howtos/code/after/en.md +++ b/markdown/dev/howtos/code/after/en.md @@ -7,7 +7,9 @@ make sure to draft all of a part's dependencies before drafting the part itself. -Do not confuse this with [part inheritance](/howtos/code/from). +Even though inherited parts are automatically included in a part's dependencies, +do not confuse part dependencies with [part inheritance](/howtos/code/from). + Part dependencies are configured with [the `after` diff --git a/markdown/dev/howtos/code/create-new-design/en.md b/markdown/dev/howtos/code/create-new-design/en.md index dab275ebb08..ea87ffd3adc 100644 --- a/markdown/dev/howtos/code/create-new-design/en.md +++ b/markdown/dev/howtos/code/create-new-design/en.md @@ -3,10 +3,10 @@ title: Creating a new pattern design --- When creating a new design, you have two options. You can create it in a -stand-along development environment. Or you can create it inside (your fork of) +stand-alone development environment. Or, you can create it inside (your fork of) the FreeSewing monorepo. -If you are unsure what to pick, go with the standalong development environment. +If you are unsure what to pick, go with the stand-alone development environment. It is the best choice for people new to FreeSewing. Working inside the monorepo is the preferred way of regular contributors, but @@ -15,7 +15,7 @@ when in doubt, go stand-alone. You can always change track later. ## Stand-alone -To setup the standalong development environment, you need NodeJS 16 or higher. +To setup the stand-alone development environment, you need NodeJS 16 or higher. Then run: ```sh @@ -37,4 +37,4 @@ yarn new design These commands will clone your fork of the [freesewing/freesewing](https://github.com/freesewing/freesewing) repository on -Github and set it up for development. +GitHub and set it up for development. diff --git a/markdown/dev/howtos/code/hide-paths/en.md b/markdown/dev/howtos/code/hide-paths/en.md index 677d6565a84..80e9e747512 100644 --- a/markdown/dev/howtos/code/hide-paths/en.md +++ b/markdown/dev/howtos/code/hide-paths/en.md @@ -22,7 +22,7 @@ Do __not__ replace the `path` object: paths = {} ``` -as the `paths` object is more than a pojo (plain old javascript object) +as the `paths` object is more than a pojo (plain old JavaScript object) diff --git a/markdown/dev/howtos/code/text-whitespace/en.md b/markdown/dev/howtos/code/text-whitespace/en.md index cb46fec8d7e..316ca542fd8 100644 --- a/markdown/dev/howtos/code/text-whitespace/en.md +++ b/markdown/dev/howtos/code/text-whitespace/en.md @@ -11,7 +11,7 @@ show you have to handle both below: ## Adding linebreaks to text To add linebreaks to text, you merely have to include them in your text. -When doing so, keep in mind that single-quoted strings in Javascript +When doing so, keep in mind that single-quoted strings in JavaScript will **not** pick up linebreaks. diff --git a/markdown/dev/howtos/design/fit-sleeve/en.md b/markdown/dev/howtos/design/fit-sleeve/en.md index afa04f4d10f..27935e8fd9b 100644 --- a/markdown/dev/howtos/design/fit-sleeve/en.md +++ b/markdown/dev/howtos/design/fit-sleeve/en.md @@ -15,13 +15,13 @@ This pattern is rather common, and we will unpack an example from Bent below. Before we dive in, here's a few things to keep in mind: -- In Javascript, you can create a function within your function and call it +- In JavaScript, you can create a function within your function and call it - Bent extends Brian which sets both the `frontArmholeLength` and `backArmholeLength` values in the store with the length of those seams - We need to match the length of the sleevecap + sleeve cap ease to the length of the front and back armhole Here's how you can handle this in code: -- We create a method that does teh actual drafting of our sleevecap +- We create a method that does the actual drafting of our sleevecap - We use a `tweak` value to influence the process, we start with a value of `1` - We check the length after every attempt, and adjust the `tweak` value @@ -74,4 +74,4 @@ A few things that are important: - We check to see how close we are by using `Math.abs(delta)` which gives us the absolute value of our delta - We guard against an endless loop by keeping track of the runs and giving up after 25 - We multiply by `0.99` and `1.02` to respectively decrease and increase our `tweak` factor. - This assymetric approach avoids that we end up ping-ponging around our target value and never land somewhere in the middle + This asymmetric approach avoids that we end up ping-ponging around our target value and never land somewhere in the middle diff --git a/markdown/dev/howtos/design/seam-allowance/en.md b/markdown/dev/howtos/design/seam-allowance/en.md index 141d11eb82d..00642a550cb 100644 --- a/markdown/dev/howtos/design/seam-allowance/en.md +++ b/markdown/dev/howtos/design/seam-allowance/en.md @@ -5,7 +5,7 @@ title: Add seam allowance and/or hem allowance Adding seam allowance is something that has to happen in every pattern. We might also have a hem where we need to add more seam allowance, or hem allowance. -When doing this, it's best to split up your path so in those sections that share the same +When doing this, it's best to split up your path into sections that share the same seam allowance. In the example below we have two such paths: diff --git a/markdown/dev/howtos/editors/blogpost/en.md b/markdown/dev/howtos/editors/blogpost/en.md index 217a977d822..9d4d7eecdef 100644 --- a/markdown/dev/howtos/editors/blogpost/en.md +++ b/markdown/dev/howtos/editors/blogpost/en.md @@ -5,7 +5,7 @@ title: Adding a blog post Blog posts have been migrated to [Strapi](https://strapi.io/), a headless CMS system. -Our strapi instance can be accessed at +Our Strapi instance can be accessed at [posts.freesewing.org](https://posts.freesewing.org/). If you don't have a Strapi account (yet), [reach out to us on diff --git a/markdown/dev/howtos/editors/frontmatter/about/en.md b/markdown/dev/howtos/editors/frontmatter/about/en.md index 8da7b806806..854200f4b8d 100644 --- a/markdown/dev/howtos/editors/frontmatter/about/en.md +++ b/markdown/dev/howtos/editors/frontmatter/about/en.md @@ -1,5 +1,5 @@ --- -title: About frontmatter +title: About Frontmatter order: 10 --- diff --git a/markdown/dev/howtos/editors/frontmatter/en.md b/markdown/dev/howtos/editors/frontmatter/en.md index 382394b7e45..a3f3bb16830 100644 --- a/markdown/dev/howtos/editors/frontmatter/en.md +++ b/markdown/dev/howtos/editors/frontmatter/en.md @@ -1,5 +1,5 @@ --- -title: Working with frontmatter +title: Working with Frontmatter --- Frontmatter is a way to add metadata to markdown documents. diff --git a/markdown/dev/howtos/editors/frontmatter/multi-line/en.md b/markdown/dev/howtos/editors/frontmatter/multi-line/en.md index 1b08a73268c..7173c750861 100644 --- a/markdown/dev/howtos/editors/frontmatter/multi-line/en.md +++ b/markdown/dev/howtos/editors/frontmatter/multi-line/en.md @@ -1,9 +1,9 @@ --- -title: Mult-line text +title: Multi-line text order: 40 --- -To add multi-line text in frontmatter, use a `|` character, +To add multi-line text in Frontmatter, use a `|` character, and prefix the lines by spaces: ```md diff --git a/markdown/dev/howtos/editors/showcase/en.md b/markdown/dev/howtos/editors/showcase/en.md index 6a0c366059c..d7a323d306f 100644 --- a/markdown/dev/howtos/editors/showcase/en.md +++ b/markdown/dev/howtos/editors/showcase/en.md @@ -5,7 +5,7 @@ title: Adding a showcase on freesewing.org Showcase posts have been migrated to [Strapi](https://strapi.io/), a headless CMS system. -Our strapi instance can be accessed at +Our Strapi instance can be accessed at [posts.freesewing.org](https://posts.freesewing.org/). If you don't have a Strapi account (yet), [reach out to us on diff --git a/markdown/dev/howtos/environments/browser/en.md b/markdown/dev/howtos/environments/browser/en.md index de9db9464bc..10b23a2084f 100644 --- a/markdown/dev/howtos/environments/browser/en.md +++ b/markdown/dev/howtos/environments/browser/en.md @@ -2,9 +2,9 @@ title: FreeSewing in the browser --- -Thanks to the advances in browser standardisation around Javascrip +Thanks to the advances in browser standardisation around JavaScript ESM modules, not to mention [the new Skypack CDN](https://www.skypack.dev/), -you can generate patterns in the browser with a few lines of Javascript. +you can generate patterns in the browser with a few lines of JavaScript. diff --git a/markdown/dev/howtos/environments/nodejs/en.md b/markdown/dev/howtos/environments/nodejs/en.md index 19150b8ee52..b153e4f3cae 100644 --- a/markdown/dev/howtos/environments/nodejs/en.md +++ b/markdown/dev/howtos/environments/nodejs/en.md @@ -68,7 +68,7 @@ console.log(svg) - 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/) - We are using `@freesewing/plugin-theme` to theme our SVG, but you - could [pass in your own CSS](/guides/plugins/using-hooks-without-plugin) + could [pass in your own CSS](/reference/api/svg/style) diff --git a/markdown/dev/howtos/git/editing-content-on-github/en.md b/markdown/dev/howtos/git/editing-content-on-github/en.md index dfe6523de7f..9d4d31aa10c 100644 --- a/markdown/dev/howtos/git/editing-content-on-github/en.md +++ b/markdown/dev/howtos/git/editing-content-on-github/en.md @@ -1,5 +1,5 @@ --- -title: Editing freesewing content on GitHub +title: Editing FreeSewing content on GitHub --- ## Introduction @@ -7,7 +7,7 @@ title: Editing freesewing content on GitHub This 'How to' is designed to help get you started editing content using the [GitHub website](https://github.com/freesewing). -GitHub stores a lot of Freesewing content, it allows anyone to suggest +GitHub stores a lot of FreeSewing content, it allows anyone to suggest edits, and helps the contributors to review and implement approved changes. If you are new to GitHub, you will need to [create an @@ -41,7 +41,7 @@ but this guide should be enough to help you get started. ## Fork the repository -- On GitHub.com, navigate to the freesewing +- On GitHub.com, navigate to the FreeSewing [repository](https://github.com/freesewing/freesewing) - In the top-right corner of the page, click **Fork** ![Fork button](fork_button.png) diff --git a/markdown/dev/howtos/git/en.md b/markdown/dev/howtos/git/en.md index d5cd3d55c0d..c2409751661 100644 --- a/markdown/dev/howtos/git/en.md +++ b/markdown/dev/howtos/git/en.md @@ -3,8 +3,8 @@ title: Common git challenges --- Git is a distributed version control system originally created by -Linus Torvalds (of linux fame). -Much like Linux itself, git is immensly powerful yet can be intimidating +Linus Torvalds (of Linux fame). +Much like Linux itself, git is immensely powerful yet can be intimidating at first. Below are some common challenges when working with FreeSewing code in git: diff --git a/markdown/dev/howtos/ways-to-contribute/develop-patterns/en.md b/markdown/dev/howtos/ways-to-contribute/develop-patterns/en.md index 2848fe7c16d..ad8bcdb8a6d 100644 --- a/markdown/dev/howtos/ways-to-contribute/develop-patterns/en.md +++ b/markdown/dev/howtos/ways-to-contribute/develop-patterns/en.md @@ -3,5 +3,5 @@ title: Develop sewing patterns --- You could program new designs for FreeSewing. -If you're not afraid of Javascript and are happy to team up with a designer, +If you're not afraid of JavaScript and are happy to team up with a designer, you could work on a new pattern together. diff --git a/markdown/dev/howtos/ways-to-contribute/devops/en.md b/markdown/dev/howtos/ways-to-contribute/devops/en.md index c5e03ba144d..a7f30b19283 100644 --- a/markdown/dev/howtos/ways-to-contribute/devops/en.md +++ b/markdown/dev/howtos/ways-to-contribute/devops/en.md @@ -2,7 +2,7 @@ title: Devops --- -We have use a lot of automation from Github actions to automated deployment on Vercel. +We have use a lot of automation from GitHub actions to automated deployment on Vercel. We also have some Ansible playbooks to run maintenance tasks. There's also other technical tasks like database or server administration, certificate renewal, and so on. diff --git a/markdown/dev/howtos/ways-to-contribute/showcase-our-patterns/en.md b/markdown/dev/howtos/ways-to-contribute/showcase-our-patterns/en.md index b883597655f..810bd7cef3c 100644 --- a/markdown/dev/howtos/ways-to-contribute/showcase-our-patterns/en.md +++ b/markdown/dev/howtos/ways-to-contribute/showcase-our-patterns/en.md @@ -13,7 +13,7 @@ If you've got pictures, there's a few ways you can get them on the site: - [Facebook](#facebook) - [Discord](#discrod) - [Reddit](#reddit) -- [Github](#github) +- [GitHub](#github) - [Email](#email) ### Instagram @@ -36,9 +36,9 @@ Post your pictures — or a link to them — in the `#pattern-showcase` channel Post your pictures — or a link to them — in [r/freesewing](https://www.reddit.com/r/freesewing). -### Github +### GitHub -Create an issue [on Github](https://github.com/freesewing/freesewing/issues/new?assignees=\&labels=%F0%9F%91%8D+good+first+issue%2C+%F0%9F%93%B8+showcase%2C+%F0%9F%A4%97+community\&template=4_showcase-template.md\&title=Create+showcase+from+this+content) and attach your pictures to it, or include a link to the pictures. +Create an issue [on GitHub](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=:%2B1:+good+first+issue%2C+:camera_flash:+showcase%2C+:hugs:+community&template=04_showcase-template.yaml&title=%5Bshowcase%5D%3A+Found+a+great+project+to+showcase) and attach your pictures to it, or include a link to the pictures. ### Email diff --git a/markdown/dev/howtos/ways-to-contribute/technical-writing/code/en.md b/markdown/dev/howtos/ways-to-contribute/technical-writing/code/en.md index 9187ecb54f4..eabdb17dd93 100644 --- a/markdown/dev/howtos/ways-to-contribute/technical-writing/code/en.md +++ b/markdown/dev/howtos/ways-to-contribute/technical-writing/code/en.md @@ -4,4 +4,4 @@ title: Writing for freesewing.dev You could write documentation for freesewing.dev, our developers website. -You would need good writing skills and a familiarity with code (Javascript). +You would need good writing skills and a familiarity with code (JavaScript).