Skip to content

Commit 35c632e

Browse files
committed
standardize: In-app Doumentation
1 parent 7a4bd9c commit 35c632e

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

packages/dev/src/Nav.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export const Nav: NavInterface[] = [
3131
to: '/quickstarts-context',
3232
},
3333
{
34-
id: 'in-context-help',
35-
name: 'In Context Help',
36-
to: '/in-context-help',
34+
id: 'in-app-documentation',
35+
name: 'In-app Documentation',
36+
to: '/in-app-documentation',
3737
},
3838
];
3939

packages/dev/src/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ ReactDOM.render(
4848
<DefaultCatalog hint="This catalog is for testing the context based quick starts approach by utilizing the QuickStartContextProvider" />
4949
</AppContext>
5050
</Route>
51-
<Route exact path="/in-context-help">
51+
<Route exact path="/in-app-documentation">
5252
<AppHelpTopicDemo>
5353
<MockConsole />
5454
</AppHelpTopicDemo>

packages/dev/src/quickstarts-data/quick-start-test-data.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import sampleApplicationQuickstart from './yaml/sample-application-quickstart.ya
2121
import serverlessApplicationQuickstart from './yaml/serverless-application-quickstart.yaml';
2222
import springWithS2i from './yaml/spring-with-s2i.yaml';
2323

24-
// in-context help examples
25-
import exampleHelpTopics from './yaml/in-context-help/example-topics.yaml';
24+
// In-app Documentation examples
25+
import exampleHelpTopics from './yaml/in-app-documentation/example-topics.yaml';
2626

2727
export const allQuickStarts: QuickStart[] = [
2828
template,

packages/dev/src/quickstarts-data/yaml/in-context-help/example-topics.yaml renamed to packages/dev/src/quickstarts-data/yaml/in-app-documentation/example-topics.yaml

File renamed without changes.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ By providing a set of quick starts to the `QuickStartContainer`, a full page cat
5050

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

53-
## In App Documentation
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`:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { LoadingBox, HelpTopicContainer, HelpTopicContext } from '@patternfly/qu
1414
import { helpTopics as exampleHelpTopics } from './example-data';
1515
import '@patternfly/quickstarts/dist/quickstarts.css';
1616

17-
## In App Documentation
17+
## In-app Documentation
1818

1919
### Basic Example
2020
```js file="./HelpTopic.jsx"

0 commit comments

Comments
 (0)