@powerhousedao/academy 3.2.0-dev.3 → 3.2.0-dev.4
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 +10 -0
- package/docs/academy/01-GetStarted/home.mdx +6 -6
- package/docs/academy/02-MasteryTrack/01-BuilderEnvironment/02-StandardDocumentModelWorkflow.md +3 -2
- package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/07-ExampleToDoListRepository.md +4 -4
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/01-BuildingDocumentEditors.md +5 -4
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/02-ConfiguringDrives.md +0 -2
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/03-BuildingADriveExplorer.md +483 -89
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/07-DocumentTools/{00-DocumentToolbar.md → 00-DocumentToolbar.mdx} +7 -2
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/07-DocumentTools/01-OperationHistory.md +3 -3
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/07-DocumentTools/02-RevisionHistoryTimeline.md +14 -3
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/07-DocumentTools/images/DocumentToolbar.png +0 -0
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/07-DocumentTools/images/revision-history-timeline.png +0 -0
- package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/08-Authorization/01-RenownAuthenticationFlow.md +14 -3
- package/docs/academy/02-MasteryTrack/04-WorkWithData/01-ReadingAndWritingThroughTheAPI.mdx +9 -15
- package/docs/academy/04-APIReferences/01-ReactHooks.md +209 -0
- package/package.json +1 -1
- package/docs/academy/04-APIReferences/01-ReactHooks +0 -98
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
## 3.2.0-dev.4 (2025-06-25)
|
|
2
|
+
|
|
3
|
+
### 🚀 Features
|
|
4
|
+
|
|
5
|
+
- added drive analytics processor ([#1607](https://github.com/powerhouse-inc/powerhouse/pull/1607))
|
|
6
|
+
|
|
7
|
+
### ❤️ Thank You
|
|
8
|
+
|
|
9
|
+
- Guillermo Puente Sandoval
|
|
10
|
+
|
|
1
11
|
## 3.2.0-dev.3 (2025-06-24)
|
|
2
12
|
|
|
3
13
|
### 🩹 Fixes
|
|
@@ -70,9 +70,9 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
70
70
|
</h3>
|
|
71
71
|
</div>
|
|
72
72
|
<div className={styles.cardContent}>
|
|
73
|
-
<a href="/academy/GetStarted/BuildToDoListEditor" className="path-button">
|
|
74
|
-
<a href="/academy/MasteryTrack/BuildingUserExperiences/BuildingDocumentEditors" className="path-button">
|
|
75
|
-
<a href="/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer" className="path-button">
|
|
73
|
+
<a href="/academy/GetStarted/BuildToDoListEditor" className="path-button">Build a todo-list editor</a>
|
|
74
|
+
<a href="/academy/MasteryTrack/BuildingUserExperiences/BuildingDocumentEditors" className="path-button">Build document editors</a>
|
|
75
|
+
<a href="/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer" className="path-button">Build custom drive explorers</a>
|
|
76
76
|
<a href="/academy/ComponentLibrary/DocumentEngineering" className="path-button">Component library</a>
|
|
77
77
|
</div>
|
|
78
78
|
</div>
|
|
@@ -98,9 +98,9 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
98
98
|
</h3>
|
|
99
99
|
</div>
|
|
100
100
|
<div className={styles.cardContent}>
|
|
101
|
-
<a href="/academy/MasteryTrack/WorkWithData/ReadingAndWritingThroughTheAPI" className="path-button">
|
|
101
|
+
<a href="/academy/MasteryTrack/WorkWithData/ReadingAndWritingThroughTheAPI" className="path-button">Read & write through the API</a>
|
|
102
102
|
<a href="/academy/MasteryTrack/WorkWithData/WorkingWithSubgraphs" className="path-button">Create your own subgraph</a>
|
|
103
|
-
<a href="/academy/MasteryTrack/WorkWithData/Analytics-Engine/intro" className="path-button">
|
|
103
|
+
<a href="/academy/MasteryTrack/WorkWithData/Analytics-Engine/intro" className="path-button">Use the analytics engine</a>
|
|
104
104
|
</div>
|
|
105
105
|
</div>
|
|
106
106
|
|
|
@@ -116,7 +116,7 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
116
116
|
<div className={styles.buttonContainer}>
|
|
117
117
|
<a href="/academy/MasteryTrack/Launch/IntroductionToPackages" className="path-button">Intro to packages</a>
|
|
118
118
|
<a href="/academy/MasteryTrack/Launch/PublishYourProject" className="path-button">Publish your project</a>
|
|
119
|
-
<a href="/academy/MasteryTrack/Launch/SetupEnvironment" className="path-button">
|
|
119
|
+
<a href="/academy/MasteryTrack/Launch/SetupEnvironment" className="path-button">Set-up a cloud environment</a>
|
|
120
120
|
</div>
|
|
121
121
|
</div>
|
|
122
122
|
</div>
|
package/docs/academy/02-MasteryTrack/01-BuilderEnvironment/02-StandardDocumentModelWorkflow.md
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
# Create Powerhouse packages
|
|
2
2
|
|
|
3
3
|
:::warning
|
|
4
|
-
**This tutorial is a summary for builders that are familiar with building document models**.
|
|
5
|
-
It
|
|
4
|
+
**This tutorial is a summary for builders that are already familiar with building document models**.
|
|
5
|
+
It provides a summary from initial setup up to publishing a distributable package.
|
|
6
|
+
|
|
6
7
|
Please start with the '**Get Started**' Chapter or '**Document Model Creation**' section if you are unfamiliar with building a document model.
|
|
7
8
|
:::
|
|
8
9
|
|
package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/07-ExampleToDoListRepository.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
# Example: Todo
|
|
1
|
+
# Example: Todo-demo-package
|
|
2
2
|
|
|
3
3
|
:::info
|
|
4
4
|
|
|
5
|
-
The
|
|
5
|
+
The Todo-demo-package is maintained by the Powerhouse Team and serves as a reference for testing and introducing new features. It will be continuously updated alongside the accompanying documentation.
|
|
6
6
|
|
|
7
7
|
https://github.com/powerhouse-inc/todo-demo-package
|
|
8
8
|
:::
|
|
9
9
|
|
|
10
10
|
There are several ways to explore this package:
|
|
11
11
|
|
|
12
|
-
### Option 1: Rebuild the
|
|
12
|
+
### Option 1: Rebuild the Todo-demo-package
|
|
13
13
|
|
|
14
|
-
The
|
|
14
|
+
The Todo-demo-package and repository are your main reference points during the Mastery Track.
|
|
15
15
|
Follow the steps in the "Mastery Track – Document Model Creation" chapters to build along with the examples.
|
|
16
16
|
|
|
17
17
|
### Option 2: Clone and run the code locally
|
package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/01-BuildingDocumentEditors.md
CHANGED
|
@@ -24,7 +24,7 @@ Powerhouse aims to keep your developer experience clean, familiar, and focused:
|
|
|
24
24
|
To kickstart your editor development, Powerhouse provides a command to generate a basic editor template. This command reads your document model specifications and creates the initial `editor.tsx` file.
|
|
25
25
|
If you want a refresher on how to define your document model specification please read the chapter on [specifying the State Schema](/academy/MasteryTrack/DocumentModelCreation/SpecifyTheStateSchema)
|
|
26
26
|
|
|
27
|
-
For example, to generate an editor for a
|
|
27
|
+
For example, to generate an editor for a To-do List document model with a document type `powerhouse/todolist`:
|
|
28
28
|
```bash
|
|
29
29
|
ph generate --editor ToDoList --document-types powerhouse/todolist
|
|
30
30
|
```
|
|
@@ -40,7 +40,7 @@ You have several options for styling your editor components:
|
|
|
40
40
|
*Example (from the ToDoList Editor):*
|
|
41
41
|
```typescript
|
|
42
42
|
<div className="container mx-auto p-4 max-w-md">
|
|
43
|
-
<h1 className="text-2xl font-bold mb-4">
|
|
43
|
+
<h1 className="text-2xl font-bold mb-4">ToDoList</h1>
|
|
44
44
|
{/* ... more Tailwind styled elements */}
|
|
45
45
|
</div>
|
|
46
46
|
```
|
|
@@ -114,7 +114,7 @@ The actual state modification logic resides in your document model's reducers, e
|
|
|
114
114
|
|
|
115
115
|
## Powerhouse component library
|
|
116
116
|
|
|
117
|
-
Powerhouse provides a rich set of reusable UI components through the **`@powerhousedao/document-engineering/scalars`** package. These components are designed for consistency, efficiency, and seamless integration with the Powerhouse ecosystem, with many based on GraphQL scalar types.
|
|
117
|
+
Powerhouse provides a rich set of reusable UI components through the **`@powerhousedao/document-engineering/scalars`** package. These components are designed for consistency, efficiency, and seamless integration with the Powerhouse ecosystem, with many based on GraphQL scalar types. For more information read our chapter on the [Component Library](/academy/ComponentLibrary/DocumentEngineering)
|
|
118
118
|
|
|
119
119
|
### Exploring components
|
|
120
120
|
You can explore available components, see usage examples, and understand their properties (props) using our Storybook instance:
|
|
@@ -261,7 +261,7 @@ export const InputField = (props: InputFieldProps) => {
|
|
|
261
261
|
Below is the complete code for the To-Do List editor. It primarily uses Tailwind CSS for styling and imports the local `Checkbox` and `InputField` components you created in the previous step. These local components, in turn, utilize elements from the Powerhouse Document Engineering design system.
|
|
262
262
|
|
|
263
263
|
<details>
|
|
264
|
-
<summary>Complete To-do
|
|
264
|
+
<summary>Complete To-do list editor example (using Tailwind CSS)</summary>
|
|
265
265
|
|
|
266
266
|
```typescript
|
|
267
267
|
import { EditorProps } from 'document-model'; // Core type for editor components.
|
|
@@ -502,5 +502,6 @@ The editor will update dynamically, so you can play around with your editor styl
|
|
|
502
502
|
Congratulations!
|
|
503
503
|
If you managed to follow this tutorial until this point, you have successfully implemented the **To-do List** document model with its reducer operations and editor.
|
|
504
504
|
|
|
505
|
+
## Up Next
|
|
505
506
|
Now you can move on to creating a [custom drive explorer](/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer) for your To-do List document.
|
|
506
507
|
Imagine you have many To-do Lists 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!
|
|
@@ -109,8 +109,6 @@ You can also add a new remote drive to your Connect environment programmatically
|
|
|
109
109
|
}
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
|
|
113
|
-
|
|
114
112
|
4. **Construct the Drive URL**
|
|
115
113
|
- Once you have the `id` or `slug`, you can construct the drive URL for Connect:
|
|
116
114
|
- Format: `domain/d/driveId` or `domain/d/driveSlug`
|