Skip to content

Commit e4f2272

Browse files
committed
Fixed broken interior docs links
1 parent 7d996d6 commit e4f2272

16 files changed

+37
-40
lines changed

packages/docs/src/docs/advanced-config-options.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Sets whether or not to delete `public.patterns/` upon each build of Pattern Lab.
2929

3030
### defaultPattern
3131

32-
Sets a specific pattern upon launch of the styleguide. This pattern will not be available in the navigation, or in view all pages. The only way to get to it will be via a refresh. Set it using the [short-hand pattern-include syntax](http://localhost:4000/docs/pattern-including.html):
32+
Sets a specific pattern upon launch of the styleguide. This pattern will not be available in the navigation, or in view all pages. The only way to get to it will be via a refresh. Set it using the [short-hand pattern-include syntax](/docs/including-patterns/):
3333

3434
```javascript
3535
"defaultPattern": "pages-welcome",
@@ -160,7 +160,7 @@ Sets the panel name and language for the code tab on the styleguide. Since this
160160

161161
### patternStateCascade
162162

163-
See the [Pattern State Documentation](http://patternlab.io/docs/pattern-states.html#node)
163+
See the [Pattern State Documentation](/docs/using-pattern-states/)
164164

165165
**default**:
166166

@@ -176,7 +176,7 @@ Sets the location that any export operations should output files to. This may be
176176

177177
### patternExportPatternPartials
178178

179-
Sets an array of patterns (using the [short-hand pattern-include syntax](http://localhost:4000/docs/pattern-including.html)) to be exported after a build.
179+
Sets an array of patterns (using the [short-hand pattern-include syntax](/docs/including-patterns/)) to be exported after a build.
180180

181181
For example, to export the navigation, header, and footer, one might do:
182182

@@ -200,7 +200,7 @@ Sets live-server options. See the [live-server documentation](https://github.com
200200

201201
### starterkitSubDir
202202

203-
[Starterkits](http://localhost:4000/docs/advanced-starterkits.html) by convention house their files within the `dist/` directory. Should someone ever wish to change this, this key is available.
203+
[Starterkits](/docs/starterkits/) by convention house their files within the `dist/` directory. Should someone ever wish to change this, this key is available.
204204

205205
**default**:
206206

@@ -251,7 +251,7 @@ See the [initial release notes](https://github.com/pattern-lab/styleguidekit-ass
251251

252252
### uikits
253253

254-
Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). They are an evolution of the original Styleguidekit pattern which separated front-end templates from front-end assets like stylesheets and code. The existing `styleguidekit-assets-default` and `styleguidekit-mustache-default` have merged into `uikit-workshop`.
254+
Introduced in Pattern Lab Node v3, UIKits are a new term in the Pattern Lab [Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/). They are an evolution of the original Styleguidekit pattern which separated front-end templates from front-end assets like stylesheets and code. The existing `styleguidekit-assets-default` and `styleguidekit-mustache-default` have merged into `uikit-workshop`.
255255

256256
`uikits` accepts an array of UIKit objects, shipping with the one above.
257257

packages/docs/src/docs/advanced-ecosystem-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Have a trusty set of boilerplate code that you start every project with? Perhaps
3535

3636
Importing a starterkit is only a few keystrokes away after installation.
3737

38-
[Learn more about Starterkits](/docs/advanced-starterkits.html#node)
38+
[Learn more about Starterkits](/docs/starterkits/)
3939

4040
### StyleguideKits
4141

@@ -55,4 +55,4 @@ The flexibility of the Pattern Lab ecosystem means that teams can develop tools
5555

5656
## Guidance and Help
5757

58-
If you have ideas or would like guidance before we have all of the documentation done please learn how you can [engage with the Pattern Lab community](/contribute.html).
58+
If you have ideas or would like guidance before we have all of the documentation done please learn how you can [engage with the Pattern Lab community](/support/).

packages/docs/src/docs/advanced-integration-with-grunt.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ eleventyNavigation:
1111

1212
**Note:** _These directions may be incomplete. They also require **v0.7.9** of the PHP version of Pattern Lab._
1313

14-
# Integration with Grunt
15-
1614
Setting up Grunt to work with the PHP version of Pattern Lab should be straightforward. To do so please do the following:
1715

1816
1. Open a terminal window

packages/docs/src/docs/advanced-starterkits.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ eleventyNavigation:
99
order: 300
1010
---
1111

12-
Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/advanced-ecosystem-overview.html) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design.
12+
Starterkits are a potent way create or augment a Pattern Lab instance with a baseline set of patterns and assets. They are an important part of the [Pattern Lab Ecosystem](/docs/overview-of-pattern-lab's-ecosystem/) An agency or team could use it for each new client or project. [Several starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) already exist to kick your project off, whether you’re looking for a blank start, begin with a demo that showcases Pattern Lab’s features, or start with a popular framework like Bootstrap, Foundation, or Material Design.
1313

1414
## Structure
1515

@@ -27,7 +27,7 @@ js/
2727
favicon.ico
2828
```
2929

30-
Teams constructing their own Starterkits should stick to this structure if they wish to publish it externally, else may alter the structure to their [configured `paths`](/docs/advanced-config-options.html#node).
30+
Teams constructing their own Starterkits should stick to this structure if they wish to publish it externally, else may alter the structure to their [configured `paths`](/docs/editing-the-configuration-options/).
3131

3232
## Installing Starterkits
3333

packages/docs/src/docs/advanced-template-language-and-pattern-engines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ eleventyNavigation:
99
order: 300
1010
---
1111

12-
By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/pattern-parameters.html). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.
12+
By default Pattern Lab uses the Mustache template language, extended with [pattern parameters](/docs/using-pattern-parameters/). PatternEngines let you add support for a template language of your personal choice. Each PatternEngine has it's own set of features and caveats.
1313

1414
Right now the most mature PatternEngines are Handlebars, Mustache and Twig.
1515

packages/docs/src/docs/data-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ The Node version of Pattern Lab only supports JSON.
2020
There are three places to store data in Pattern Lab:
2121

2222
- in `./source/_data`.
23-
- in [pattern-specific](/docs/data-pattern-specific.html) files in `./source/_patterns`.
24-
- in [pseudo-pattern](/docs/pattern-pseudo-patterns.html) files in `./source/_patterns`.
23+
- in [pattern-specific](/docs/creating-pattern-specific-values/) files in `./source/_patterns`.
24+
- in [pseudo-pattern](/docs/using-pseudo-patterns/) files in `./source/_patterns`.
2525

2626
### A Special Note About Pattern Parameters
2727

28-
[Pattern parameters](/docs/pattern-parameters.html) are a simple find and replace of variables in the included pattern. As such they do not affect the context stack of Mustache and we don't consider them true data. They have no impact on overall data inheritance and they cannot be used any deeper than the included pattern. They are a hack.
28+
[Pattern parameters](/docs/using-pattern-parameters/) are a simple find and replace of variables in the included pattern. As such they do not affect the context stack of Mustache and we don't consider them true data. They have no impact on overall data inheritance and they cannot be used any deeper than the included pattern. They are a hack.
2929

3030
## Data Inheritance
3131

packages/docs/src/docs/editing-source-files.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ eleventyNavigation:
99
order: 20
1010
---
1111

12-
When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/pattern-managing-assets.html). Each time [your site is generated](/docs/generating-pattern-lab.html) your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory.
12+
When editing Pattern Lab you must put your files and edit them in the `./source/` directory. This includes your static assets like [JavaScript, CSS, and images](/docs/managing-pattern-assets/). Each time your site is generated your patterns will be compiled and your static assets will be moved to the `./public/` directory. Because of this you **should not edit** the files in the `./public/` directory.
1313

1414
## Pattern Lab Directories
1515

1616
For the most part you can organize `./source/` anyway you see fit. There are a few Pattern Lab-specific directories though. They are:
1717

18-
- `_annotations/` - where your annotations reside. [learn more](/docs/pattern-adding-annotations.html).
19-
- `_data/` - where the global data used to render your patterns resides. [learn more](/docs/data-overview.html).
20-
- `_meta/` - where the header and footer that get applied to all of your patterns resides. [learn more](/docs/pattern-header-footer.html).
21-
- `_patterns/` - where your patterns, pattern documentation, and pattern-specific data reside. [learn more](/docs/pattern-organization.html).
18+
- `_annotations/` - where your annotations reside. [learn more](/docs/adding-annotations/).
19+
- `_data/` - where the global data used to render your patterns resides. [learn more](/docs/overview-of-data/).
20+
- `_meta/` - where the header and footer that get applied to all of your patterns resides. [learn more](/docs/modifying-the-pattern-header-and-footer/).
21+
- `_patterns/` - where your patterns, pattern documentation, and pattern-specific data reside. [learn more](/docs/reorganizing-patterns/).
2222

2323
## Configuring Pattern Lab Directories
2424

@@ -77,4 +77,4 @@ In the Node version of Pattern Lab you can modify the following configuration op
7777

7878
## Watching for Source File Changes
7979

80-
Manually generating the Pattern Lab website after each change can be cumbersome. The Node version of Pattern Lab comes with the ability to [watch files in the `./source/` directory for changes and re-generate the site automatically](/docs/advanced-auto-regenerate.html). The Pattern Lab website can also be [automatically reloaded](/docs/advanced-reload-browser.html).
80+
Manually generating the Pattern Lab website after each change can be cumbersome. The Node version of Pattern Lab comes with the ability to watch files in the `./source/` directory for changes and re-generate the site automatically. The Pattern Lab website can also be automatically reloaded..

packages/docs/src/docs/installation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This will bring up an installation menu that presents the following steps:
3838

3939
## Step 5: Choose initial patterns
4040

41-
**`What initial patterns do you want included in your project?`** - Choose the <a href="/docs/advanced-starterkits.html">Starterkit</a> you want to begin your project with. The options are:
41+
**`What initial patterns do you want included in your project?`** - Choose the <a href="/docs/starterkits/">Starterkit</a> you want to begin your project with. The options are:
4242

4343
- **`Handlebars base patterns`** `(some basic patterns to get started with)` - TODO: include demo link
4444
- **`Handlebars demo patterns`** `(full demo website and patterns)` - TODO: include demo link
@@ -50,4 +50,3 @@ This will bring up an installation menu that presents the following steps:
5050

5151
**`Are you happy with your choices? (Hit enter for YES)?`** - Confirm your choices, and when done the Pattern Lab installation will begin.
5252

53-
Once installation is complete, you're ready to <a href="/docs/generating-pattern-lab.html">generate Pattern Lab for the first time.</a>

packages/docs/src/docs/pattern-add-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ If we want to add a new pattern we simply tack it onto the end:
2222
media-block.mustache
2323
new-pattern.mustache
2424

25-
If you want more control over their ordering please refer to "[Reorganizing Patterns](/docs/pattern-reorganizing.html)."
25+
If you want more control over their ordering please refer to "[Reorganizing Patterns](/docs/reorganizing-patterns/)."

packages/docs/src/docs/pattern-converting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ eleventyNavigation:
99
order: 190
1010
---
1111

12-
You may have invested time in building patterns for Brad's original edition of Pattern Lab but now want to convert them so they can be used with the new PHP version of Pattern Lab. To convert them all you need to do is swap out the old `inc()` calls for the Mustache-based [shorthand partials syntax](/docs/pattern-including.html). For example, let's say this was a call to a pattern using the original syntax:
12+
You may have invested time in building patterns for Brad's original edition of Pattern Lab but now want to convert them so they can be used with the new PHP version of Pattern Lab. To convert them all you need to do is swap out the old `inc()` calls for the Mustache-based [shorthand partials syntax](/docs/including-patterns/). For example, let's say this was a call to a pattern using the original syntax:
1313

1414
<?php inc('atom','logo') ?>
1515

0 commit comments

Comments
 (0)