@powerhousedao/academy 2.5.0-dev.28 → 2.5.0-dev.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/02-SpecifyTheStateSchema.md +1 -1
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/03-SpecifyDocumentOperations.md +1 -1
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/04-UseTheDocumentModelGenerator.md +1 -1
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/05-ImplementDocumentReducers.md +1 -1
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/06-ImplementDocumentModelTests.md +3 -2
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/01-BuildingDocumentEditors.md +3 -3
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/02-ConfiguringDrives.md +5 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -141,5 +141,5 @@ By completing these steps, you have successfully specified the data structure fo
|
|
|
141
141
|
|
|
142
142
|
</details>
|
|
143
143
|
|
|
144
|
-
For a complete, working example, you can always refer to the [Example ToDoList Repository](
|
|
144
|
+
For a complete, working example, you can always refer to the [Example ToDoList Repository](/academy/MasteryTrack/DocumentModelCreation/ExampleToDoListRepository) which contains the full implementation of the concepts discussed in this Mastery Track.
|
|
145
145
|
|
package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/03-SpecifyDocumentOperations.md
CHANGED
|
@@ -115,7 +115,7 @@ export const reducer: ToDoListToDoListOperations = {
|
|
|
115
115
|
Now that you understand the theory, let's walk through the practical steps of defining these operations for our `ToDoList` document model within the Powerhouse Connect application.
|
|
116
116
|
|
|
117
117
|
<details>
|
|
118
|
-
<summary>Tutorial: Specifying
|
|
118
|
+
<summary>Tutorial: Specifying ToDoList Operations</summary>
|
|
119
119
|
|
|
120
120
|
Assuming you have already defined the state schema for the `ToDoList` as covered in the previous section, follow these steps to add the operations:
|
|
121
121
|
|
package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/04-UseTheDocumentModelGenerator.md
CHANGED
|
@@ -95,7 +95,7 @@ Leveraging the `ph generate` command offers numerous advantages:
|
|
|
95
95
|
Now that you understand what the Document Model Generator does, let's walk through the practical steps of using it with our `ToDoList` example.
|
|
96
96
|
|
|
97
97
|
<details>
|
|
98
|
-
<summary>Tutorial: Generating the
|
|
98
|
+
<summary>Tutorial: Generating the ToDoList Document Model</summary>
|
|
99
99
|
|
|
100
100
|
This tutorial assumes you have completed the previous steps in this Mastery Track, where you defined the state schema and operations for the `ToDoList` model in Connect and exported it.
|
|
101
101
|
|
package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/05-ImplementDocumentReducers.md
CHANGED
|
@@ -237,7 +237,7 @@ Using these types provides:
|
|
|
237
237
|
Now that you understand the principles, let's put them into practice by implementing the reducers for our `ToDoList` document model.
|
|
238
238
|
|
|
239
239
|
<details>
|
|
240
|
-
<summary>Tutorial: Implementing the
|
|
240
|
+
<summary>Tutorial: Implementing the ToDoList Reducers</summary>
|
|
241
241
|
|
|
242
242
|
This tutorial assumes you have followed the steps in the previous chapters, especially using `ph generate ToDoList.phdm.zip` to scaffold your document model's code.
|
|
243
243
|
|
package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/06-ImplementDocumentModelTests.md
CHANGED
|
@@ -134,5 +134,6 @@ Implementing comprehensive tests for your document model reducers is an investme
|
|
|
134
134
|
By following the tutorial and applying these best practices, you can build a strong suite of tests that safeguard the integrity and functionality of your document models. This diligence is a hallmark of a "Mastery Track" developer, ensuring that the solutions you build are not just functional but also stable, maintainable, and trustworthy.
|
|
135
135
|
|
|
136
136
|
## Up Next
|
|
137
|
-
In the next chapter of the Mastery Track you will learn how to implement an editor for your document model so you can see a simple user interface for the **ToDoList** document model in action.
|
|
138
|
-
|
|
137
|
+
In the next chapter of the Mastery Track - Building User Experiences you will learn how to implement an editor for your document model so you can see a simple user interface for the **ToDoList** document model in action.
|
|
138
|
+
|
|
139
|
+
For a complete, working example, you can always refer to the [Example ToDoList Repository](/academy/MasteryTrack/DocumentModelCreation/ExampleToDoListRepository) which contains the full implementation of the concepts discussed in this Mastery Track.
|
package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/01-BuildingDocumentEditors.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Build Document Editors
|
|
1
|
+
# Build Document Editors
|
|
2
2
|
|
|
3
3
|
## Build with React on Powerhouse
|
|
4
4
|
|
|
@@ -499,10 +499,10 @@ Click on it to create a new ToDoList document.
|
|
|
499
499
|
The editor will update dynamically, so you can play around with your editor styling while seeing your results appear in Connect Studio.
|
|
500
500
|
:::
|
|
501
501
|
|
|
502
|
+
</details>
|
|
503
|
+
|
|
502
504
|
Congratulations!
|
|
503
505
|
If you managed to follow this tutorial until this point, you have successfully implemented the **ToDoList** document model with its reducer operations and editor.
|
|
504
506
|
|
|
505
507
|
Now you can move on to creating a [custom drive explorer](/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer) for your ToDoList document.
|
|
506
508
|
Imagine you have many ToDoLists sitting in a drive. A custom drive explorer will allow you to organize and track them at a glance, opening up a new world of possibilities to increase the functionality of your documents!
|
|
507
|
-
|
|
508
|
-
</details>
|
|
@@ -2,12 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
A drive in Powerhouse is a container or a wrapper for documents and data. It's a place where you can organize and store your documents and share them with others. This guide will walk you through the process of configuring and managing drives in your Powerhouse environment.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
:::info **Prerequisites**
|
|
6
6
|
|
|
7
7
|
Before configuring a drive, ensure you have:
|
|
8
8
|
- Powerhouse [CLI installed](/academy/MasteryTrack/BuilderEnvironment/BuilderTools)
|
|
9
9
|
- Access to a Powerhouse instance
|
|
10
10
|
- Appropriate permissions to create and manage drives
|
|
11
|
+
:::
|
|
11
12
|
|
|
12
13
|
## Understanding Drives
|
|
13
14
|
|
|
@@ -23,7 +24,7 @@ Remote drives in Powerhouse allow you to connect to and work with data stored in
|
|
|
23
24
|
- **Cloud Storage**: For centralized, scalable data management.
|
|
24
25
|
- **Decentralized Storage**: Such as Ceramic or IPFS, enabling distributed and blockchain-based storage options.
|
|
25
26
|
|
|
26
|
-
:::tip
|
|
27
|
+
:::tip **Explainer**
|
|
27
28
|
**Powerhouse Reactors** are the nodes in the network that store and synchronise documents & drives , resolve conflicts and rerun operations to verify document event histories.
|
|
28
29
|
Reactors can be configured for local storage, centralized cloud storage or on a decentralized storage network.
|
|
29
30
|
|
|
@@ -57,10 +58,11 @@ To create a new drive in Powerhouse, follow these steps:
|
|
|
57
58
|
|
|
58
59
|
You can also add a new remote drive to your Connect environment programmatically using GraphQL mutations. This is especially useful for automation, scripting, or integrating with external systems.
|
|
59
60
|
|
|
60
|
-
|
|
61
|
+
:::info **Prerequisites**
|
|
61
62
|
- Access to the Switchboard or remote reactor (server node) of your Connect instance.
|
|
62
63
|
- The GraphQL endpoint for your instance. For example, for the staging environment, use: `https://staging.switchboard.phd/graphql/system` (this is a supergraph gateway).
|
|
63
64
|
- Appropriate permissions to perform mutations.
|
|
65
|
+
:::
|
|
64
66
|
|
|
65
67
|
### Steps
|
|
66
68
|
1. **Navigate to the GraphQL Playground or use a GraphQL client**
|