VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(markdown): Broken links in dev docs

Browse source
This commit is contained in:
Joost De Cock 2022-01-12 19:27:07 +01:00
parent 5461211930
commit 72c993ae98
3 changed files with 14 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

8
markdown/dev/guides/best-practices/respect-draft-settings/en.md
View file

@ -4,7 +4,7 @@ order: 40
--- ---
Apart from the pattern options that you configure for your pattern, Apart from the pattern options that you configure for your pattern,
all FreeSewing patterns have a set of [draft settings](/reference/settings/) that can be tweaked all FreeSewing patterns have a set of [draft settings](/reference/api/settings) that can be tweaked
by the user. by the user.
While many of these will automatically be handled by FreeSewing, there are some While many of these will automatically be handled by FreeSewing, there are some
@ -12,19 +12,19 @@ that you should take into account while developing your pattern. They are:
## Complete ## Complete
The [complete](/reference/settings/#complete) setting is a boolean that is either true or false. The [complete](/reference/api/settings#complete) setting is a boolean that is either true or false.
Its goal is to determine whether we should draft a *complete* pattern, or merely the outline. Its goal is to determine whether we should draft a *complete* pattern, or merely the outline.
## Paperless ## Paperless
The [paperless](/reference/settings/#paperless) setting is a boolean that is either true or false. The [paperless](/reference/api/settings#paperless) setting is a boolean that is either true or false.
A *paperless* pattern is a pattern that has extra dimensions so users can trace the A *paperless* pattern is a pattern that has extra dimensions so users can trace the
paper on fabric or paper without having the need to print it. paper on fabric or paper without having the need to print it.
## Seam allowance ## Seam allowance
The [sa](/reference/settings/#sa) setting is a number that controls the seam allowance. The [sa](/reference/api/settings#sa) setting is a number that controls the seam allowance.
Unless `sa` is zero, you should add the requested seam allowance to your pattern. Unless `sa` is zero, you should add the requested seam allowance to your pattern.

6
markdown/dev/reference/api/config/en.md
View file

@ -1,7 +1,5 @@
--- ---
title: Pattern configuration file title: Pattern configuration file
for: developers
about: Reference documentation for the pattern configuration file
--- ---
```js ```js
@ -16,13 +14,13 @@ export default {
A pattern configuration file exports a default object with the following properties: A pattern configuration file exports a default object with the following properties:
<ReadMore list /> <ReadMore />
<Note> <Note>
This is about the pattern configuration file, used at build-time. This is about the pattern configuration file, used at build-time.
For run-time configuration, see [Pattern settings](/reference/settings/). For run-time configuration, see [Pattern settings](/reference/api/settings).
</Note> </Note>

16
markdown/dev/reference/api/pattern/en.md
View file

@ -13,10 +13,10 @@ objects will generated a made-to-measure pattern.
function freesewing.Pattern(object settings) function freesewing.Pattern(object settings)
``` ```
A pattern is instantiated by passing a [settings object](/reference/settings/) to the pattern constructor. A pattern is instantiated by passing a [settings object](/reference/api/settings/) to the pattern constructor.
This settings objects holds, amongst other things, the measurements and options chosen by the user. This settings objects holds, amongst other things, the measurements and options chosen by the user.
Refer to the [settings documentation](/reference/settings/) for an exhaustive list. Refer to the [settings documentation](/reference/api/settings/) for an exhaustive list.
## Pattern properties ## Pattern properties
@ -27,18 +27,18 @@ Refer to the [settings documentation](/reference/settings/) for an exhaustive li
| `is` | A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern. | | `is` | A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern. |
| `options` | The options as set by the user | | `options` | The options as set by the user |
| `parts` | A plain object to hold your parts | | `parts` | A plain object to hold your parts |
| `Part` | The [Part](/en/docs/developer/api/part) constructor | | `Part` | The [Part](/reference/api/part) constructor |
| `settings` | The settings as set by the user | | `settings` | The settings as set by the user |
| `store` | A [Store](/en/docs/developer/api/store) instance | | `store` | A [Store](/reference/api/store) instance |
| `svg` | An [Svg](/en/docs/developer/api/svg) instance | | `svg` | An [Svg](/reference/api/svg) instance |
- `settings` : The settings as set by the user - `settings` : The settings as set by the user
- `options` : the options as set by the user - `options` : the options as set by the user
- `config` : The pattern configuration - `config` : The pattern configuration
- `parts` : A plain object to hold your parts - `parts` : A plain object to hold your parts
- `Part` : The [Part](/en/docs/developer/api/part) constructor - `Part` : The [Part](/reference/api/part) constructor
- `store` : A [Store](/en/docs/developer/api/store) instance - `store` : A [Store](/reference/api/store) instance
- `svg` : An [Svg](/en/docs/developer/api/svg) instance - `svg` : An [Svg](/reference/api/svg) instance
- `is` : A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern. - `is` : A string that will be set to `draft` or `sample` when you respectively draft or sample a pattern.
This allows plugins that hook into your pattern to determine what to do in a given scenario. This allows plugins that hook into your pattern to determine what to do in a given scenario.