Skip to content

Commit dc28e8b

Browse files
bobbravo2“Bob
and
“Bob
authored
Update demo readme and main readme (#266)
* Update docs * DRY up the demo docs * prettier cleanup --------- Co-authored-by: “Bob <“[email protected]”>
1 parent 68a950d commit dc28e8b

File tree

2 files changed

+9
-38
lines changed

2 files changed

+9
-38
lines changed

README.md

+2-32
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To use Topology, you will need to have both [Node Active LTS](https://github.com
2727
2828
## Installing Topology
2929
30-
Once you have all of the prequisites, you can install the Topology package with Yarn or npm:
30+
Once you have all of the prerequisites, you can install the Topology package with Yarn or npm:
3131
3232
1. Using Yarn:
3333
@@ -202,38 +202,8 @@ export const TopologyBaselineDemo = React.memo(() => {
202202

203203
To help you better understand and visualize the different Topology components, we have created an interactive demo, [which is contained here.](https://github.com/patternfly/react-topology/tree/main/packages/demo-app-ts)
204204

205-
Continue reading for instructions on how to build and run the demo app.
205+
See the instructions to install and run the demo app, here: [Demo README.md](packages/demo-app-ts/README.md)
206206

207-
### Prerequisites
208-
209-
In order to run the demo app, you need to make sure the following prerequisites are met.
210-
211-
1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites.](#prerequisites)
212-
1. If you haven’t already, [fork the Topology project.](https://github.com/patternfly/react-topology)
213-
214-
### Running the demo app
215-
216-
Once you’ve set up the prerequisites, you can follow these steps to run the docs workspace or the demo app on your local machine
217-
218-
1. In a terminal, type the following commands to start the docs workspace:
219-
220-
```
221-
yarn install
222-
yarn start
223-
```
224-
225-
2. In a terminal, type the following commands to navigate to demo-app-ts and launch the demo app:
226-
227-
```
228-
cd packages/demo-app-ts
229-
yarn start:demo-app:hot
230-
```
231-
232-
3. You will receive a message confirming that the app is running. To view the locally running workspace, visit http://localhost:8008/.
233-
234-
4. Explore the demo app in your browser:
235-
236-
![Demo app landing page.](packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)
237207

238208
## Need help?
239209
If you find a bug, have a request, or have any questions about Topology that aren't answered in our documentation, please [reach out to us on Slack.](https://patternfly.slack.com/archives/CK7URGJ2W)

packages/demo-app-ts/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[the general Topology prerequisites]: ../../README.md#prerequisites
12
# Topology demo app
23

34
To help you better understand and visualize the different Topology components, we have created an interactive demo, [which is contained here.](https://github.com/patternfly/react-topology/tree/main/packages/demo-app-ts)
@@ -8,8 +9,8 @@ Continue reading for instructions on how to build and run the demo app.
89

910
In order to run the demo app, you need to make sure the following prerequisites are met.
1011

11-
1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites.](#prerequisites)
12-
1. Make sure that you have the PatternFly React library installed. [Follow these instructions if you need to install this package.](https://github.com/patternfly/patternfly-react?tab=readme-ov-file#install-and-configure-patternfly-react)
12+
1. Make sure that you have yarn installed, as outlined in [the general Topology prerequisites].
13+
1. Make sure that you have the PatternFly React library installed. [Follow these instructions if you need to install this package.](https://github.com/patternfly/patternfly-react?tab=readme-ov-file#install-and-configure-patternfly-react)
1314
1. If you haven’t already, clone [the Topology project](https://github.com/patternfly/react-topology) and navigate to your local directory:
1415

1516
```
@@ -21,14 +22,14 @@ cd react-topology
2122

2223
Once you’ve set up the prerequisites, you can follow these steps to run the demo app on your local machine
2324

24-
1. In a terminal, type the following commands to start the docs workspace:
25+
1. In a terminal, type the following commands to start the `react topology docs workspace`:
2526

2627
```
2728
yarn install
2829
yarn start
2930
```
3031

31-
2. In a separate terminal window, type the following commands to navigate to demo-app-ts and launch the demo app:
32+
2. In a **separate** terminal window, type the following commands to navigate to `demo-app-ts` and launch the demo app:
3233

3334
```
3435
cd packages/demo-app-ts
@@ -42,9 +43,9 @@ yarn start:demo-app:hot
4243
<i> [webpack-dev-server] Loopback: http://localhost:3000/
4344
```
4445

45-
4. Explore the demo app in your browser:
46+
4. Explore the demo app in [your browser](http://localhost:3000/)
4647

47-
![Demo app landing page.](packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)
48+
![Demo app landing page.](../../packages/module/patternfly-docs/content/examples/img/topology-demo-app.png)
4849

4950
## Need help?
5051
If you find a bug, have a request, or have any questions about Topology that aren't answered in our documentation, please [reach out to us on Slack.](https://patternfly.slack.com/archives/CK7URGJ2W)

0 commit comments

Comments
 (0)