Skip to content

Commit 7a4bd9c

Browse files
committed
spellcheck
1 parent 5949f32 commit 7a4bd9c

File tree

2 files changed

+8
-8
lines changed
  • packages/module/patternfly-docs/content/extensions/quick-starts/examples

2 files changed

+8
-8
lines changed

packages/module/patternfly-docs/content/extensions/quick-starts/examples/about.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ id: Quick Starts
99
source: about
1010
---
1111
# About
12-
The **@patternfly/quickstarts** extension is made up of two parts: `Quick starts` and `In App Documenation` product documentation tools.
12+
The **@patternfly/quickstarts** extension is made up of two parts: `Quick starts` and `In App Documentation` product documentation tools.
1313

1414
## Full live demo application
1515
A live demo of **Quick starts and In App Documentation** can be found [here](https://quickstarts.netlify.app/), or view the [demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
@@ -28,9 +28,9 @@ For more detailed design guidelines and visuals see [here.](/extensions/quick-st
2828
### Quick start format
2929

3030
#### For developers
31-
A detailed breakdown of the quickstart format in code can be seen [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/utils/quick-start-types.ts).
31+
A detailed breakdown of the Quick start format in code can be seen [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/utils/quick-start-types.ts).
3232

33-
Quickly preview a [basic exmaple](/extensions/quick-starts/Basic-Quick-Starts), and remember there is a [live demo](https://quickstarts.netlify.app/) with [full demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
33+
Quickly preview a [basic example](/extensions/quick-starts/Basic-Quick-Starts), and remember there is a [live demo](https://quickstarts.netlify.app/) with [full demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
3434

3535
#### For content authors
3636
Quick starts can be written in `yaml` with markdown support, `asciidoc`, or just `json`. For examples of each of these formats see [here](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev/src/quickstarts-data)
@@ -46,11 +46,11 @@ const { setActiveQuickStart } = React.useContext<QuickStartContextValues>(
4646
```
4747

4848
#### Quick start catalog
49-
By providing a set of quickstarts to the `QuickStartContainer`, a full page catalog view will be generated. Clicking on a catalog card will open its respective `Quick start` in the side panel.
49+
By providing a set of quick starts to the `QuickStartContainer`, a full page catalog view will be generated. Clicking on a catalog card will open its respective `Quick start` in the side panel.
5050

5151
<img src="./img/catalog.png" alt="Quick start catalog" width="1680"/>
5252

53-
## In App Documenation
53+
## In App Documentation
5454
In App Documentation is used to provide definitions for a set of topics relevant to your product. A single unit of In App Documentation can be called a `HelpTopic`, which is also the name used in code. `HelpTopic`'s essential sections are a **content** section that contains a definition of the term or topic, and an optional list of **links** to provide the user with other relevant information.
5555

5656
`HelpTopics` are displayed in a side panel just like `Quick starts`:
@@ -62,7 +62,7 @@ In App Documentation is used to provide definitions for a set of topics relevant
6262
#### For developers
6363
A detailed breakdown of the `HelpTopic` format in code can be seen [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/utils/help-topic-types.ts).
6464

65-
Quickly preview a [basic exmaple](/extensions/quick-starts/In-App-Documentation), and remember there is a [live demo](https://quickstarts.netlify.app/in-context-help) with [full demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
65+
Quickly preview a [basic example](/extensions/quick-starts/In-App-Documentation), and remember there is a [live demo](https://quickstarts.netlify.app/in-context-help) with [full demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
6666

6767
#### For content authors
6868
HelpTopics are written in `yaml` with markdown support. An example can be seen [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/in-context-help/example-topics.yaml)
@@ -74,4 +74,4 @@ Open the side panel by calling `setActiveHelpTopicByName` (available from `HelpT
7474
const { setActiveHelpTopicByName } = React.useContext<HelpTopicContextValues>(HelpTopicContext);
7575
```
7676

77-
Close it by calling `setActiveHelpTopicByName` with an empty string. There is no prebuilt `HelpTopic` catalog. simply attach a handler with `setActiveHelpTopicByName` to the appropriate DOM element. See the [basic exmaple](/extensions/quick-starts/In-App-Documentation), or [live demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev) for more details.
77+
Close it by calling `setActiveHelpTopicByName` with an empty string. There is no prebuilt `HelpTopic` catalog. simply attach a handler with `setActiveHelpTopicByName` to the appropriate DOM element. See the [basic example](/extensions/quick-starts/In-App-Documentation), or [live demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev) for more details.

packages/module/patternfly-docs/content/extensions/quick-starts/examples/basic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ id: Quick Starts
88
# Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
99
source: Basic-Quick-Starts
1010
# If you use typescript, the name of the interface to display props for
11-
# These are found through the sourceProps function provdided in patternfly-docs.source.js
11+
# These are found through the sourceProps function provided in patternfly-docs.source.js
1212
propComponents: ['QuickStartContainer']
1313
---
1414

0 commit comments

Comments
 (0)