@powerhousedao/academy 0.1.0-dev.4 → 0.1.0-dev.5
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 +12 -0
- package/docs/academy/01-GetStarted/04-BuildToDoListEditor.md +1 -1
- package/docs/academy/01-GetStarted/home.mdx +31 -42
- package/docs/academy/02-MasteryTrack/01-BuilderEnvironment/03-BuilderTools.md +1 -1
- package/docs/academy/04-APIReferences/00-PowerhouseCLI.md +17 -15
- package/package.json +2 -2
- package/sidebars.ts +2 -2
- /package/docs/academy/06-ComponentLibrary/{00-PowerhouseDesignSystem.md → 00-DocumentEngineering.md} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
## 0.1.0-dev.5 (2025-06-03)
|
|
2
|
+
|
|
3
|
+
### 🩹 Fixes
|
|
4
|
+
|
|
5
|
+
- **academy:** lockfile issue second time' ([6208fe614](https://github.com/powerhouse-inc/powerhouse/commit/6208fe614))
|
|
6
|
+
- **academy:** fix frozen lockfile issue' ([80f18ec73](https://github.com/powerhouse-inc/powerhouse/commit/80f18ec73))
|
|
7
|
+
- **academy:** fix frozen lockfile issue ([bfc3dcd21](https://github.com/powerhouse-inc/powerhouse/commit/bfc3dcd21))
|
|
8
|
+
|
|
9
|
+
### ❤️ Thank You
|
|
10
|
+
|
|
11
|
+
- Callme-T
|
|
12
|
+
|
|
1
13
|
## 0.1.0-dev.4 (2025-06-03)
|
|
2
14
|
|
|
3
15
|
### 🚀 Features
|
|
@@ -197,7 +197,7 @@ When you add the editor code, you'll see it makes use of two components, the `Ch
|
|
|
197
197
|
These are imported from the Powerhouse Document Engineering design system (`@powerhousedao/document-engineering/scalars`).
|
|
198
198
|
|
|
199
199
|
This system provides a library of reusable components to ensure consistency and speed up development.
|
|
200
|
-
You can explore available components, see usage examples, and understand their properties (props) using our Storybook instance. For a detailed guide on how to leverage the Document Engineering design system and Storybook, see [Using the Powerhouse Document Engineering](/academy/ComponentLibrary/
|
|
200
|
+
You can explore available components, see usage examples, and understand their properties (props) using our Storybook instance. For a detailed guide on how to leverage the Document Engineering design system and Storybook, see [Using the Powerhouse Document Engineering](/academy/ComponentLibrary/DocumentEngineering) page.
|
|
201
201
|
|
|
202
202
|
For this tutorial, create a `components` folder inside `editors/to-do-list`. Then, within this new `components` folder, create the files for the `Checkbox` and `InputField` components (e.g., `Checkbox.tsx` and `InputField.tsx`) with the following code:
|
|
203
203
|
:::
|
|
@@ -44,44 +44,24 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
44
44
|
</div>
|
|
45
45
|
</div>
|
|
46
46
|
|
|
47
|
-
{/*
|
|
48
|
-
<div
|
|
49
|
-
<div className={styles.cardHeader}>
|
|
50
|
-
<div className={styles.cardIconWrapper}>
|
|
51
|
-
<img src="/img/academy/icons/Book.svg" alt="" />
|
|
52
|
-
</div>
|
|
53
|
-
<h3 className="card-title">New Link</h3>
|
|
54
|
-
</div>
|
|
55
|
-
<div className={styles.cardContent}>
|
|
56
|
-
<a href="@callme-t" className="path-button">The Vision of Powerhouse</a>
|
|
57
|
-
</div>
|
|
58
|
-
</div>
|
|
47
|
+
{/* Row 1: [Empty Placeholder], Create, [Empty Placeholder] */}
|
|
48
|
+
<div></div> {/* Placeholder for the deleted "New Link" card */}
|
|
59
49
|
|
|
60
50
|
<div className={styles.pathCard} style={{ border: '1px solid #4FC86F' }}>
|
|
61
51
|
<div className={styles.cardHeader}>
|
|
62
52
|
<div className={styles.cardIconWrapper}>
|
|
63
53
|
<img src="/img/academy/icons/BuilderEnvironment.svg" alt="" />
|
|
64
54
|
</div>
|
|
65
|
-
<h3 className="card-title">
|
|
55
|
+
<h3 className="card-title">Get Started</h3>
|
|
66
56
|
</div>
|
|
67
57
|
<div className={styles.cardContent}>
|
|
68
58
|
<a href="/docs/academy/GetStarted/CreateNewPowerhouseProject" className="path-button">Build a Todo-list Document Model</a>
|
|
69
59
|
</div>
|
|
70
60
|
</div>
|
|
71
61
|
|
|
72
|
-
<div
|
|
73
|
-
<div className={styles.cardHeader}>
|
|
74
|
-
<div className={styles.cardIconWrapper}>
|
|
75
|
-
<img src="/img/academy/icons/Advanced.svg" alt="" />
|
|
76
|
-
</div>
|
|
77
|
-
<h3 className="card-title">Document Model Theory</h3>
|
|
78
|
-
</div>
|
|
79
|
-
<div className={styles.cardContent}>
|
|
80
|
-
<a href="/docs/academy/GetStarted/DocumentModelTheory/WhatIsADocumentModel" className="path-button">Deep Dive into Document Modelling</a>
|
|
81
|
-
</div>
|
|
82
|
-
</div>
|
|
62
|
+
<div></div> {/* Placeholder for the deleted "Document Model Theory" card */}
|
|
83
63
|
|
|
84
|
-
{/*
|
|
64
|
+
{/* Row 2: Build User Experiences, Builder Track Image, Work with Data */}
|
|
85
65
|
<div className={styles.pathCard} style={{ border: '1px solid #4FC86F' }}>
|
|
86
66
|
<div className={styles.cardHeader}>
|
|
87
67
|
<div className={styles.cardIconWrapper}>
|
|
@@ -91,34 +71,33 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
91
71
|
</div>
|
|
92
72
|
<div className={styles.cardContent}>
|
|
93
73
|
<a href="/docs/academy/GetStarted/BuildToDoListEditor" className="path-button">Building a Todo-list Editor</a>
|
|
94
|
-
<a href="/docs/academy/BuildingUserExperiences/BuildingBeautifulDocumentEditors" className="path-button">Building
|
|
74
|
+
<a href="/docs/academy/BuildingUserExperiences/BuildingBeautifulDocumentEditors" className="path-button">Building Document Editors</a>
|
|
95
75
|
<a href="/docs/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer" className="path-button">Building Custom Drive Explorers</a>
|
|
76
|
+
<a href="/docs/academy/ComponentLibrary/DocumentEngineering" className="path-button">Component Library</a>
|
|
96
77
|
</div>
|
|
97
78
|
</div>
|
|
98
79
|
|
|
99
|
-
{
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
alignItems: 'flex-start',
|
|
80
|
+
<div className={styles.middleColumn} style={{
|
|
81
|
+
display: 'flex',
|
|
82
|
+
justifyContent: 'center',
|
|
83
|
+
alignItems: 'flex-start',
|
|
104
84
|
paddingTop: '-20px',
|
|
105
85
|
position: 'relative'
|
|
106
86
|
}}>
|
|
107
87
|
<img src="/img/Union.svg" alt="Powerhouse Union" width="250" />
|
|
108
|
-
<div style={{
|
|
88
|
+
<div style={{
|
|
109
89
|
position: 'absolute',
|
|
110
90
|
top: '18px',
|
|
111
|
-
backgroundColor: 'white',
|
|
112
|
-
padding: '8px 16px',
|
|
91
|
+
backgroundColor: 'white',
|
|
92
|
+
padding: '8px 16px',
|
|
113
93
|
borderRadius: '8px',
|
|
114
94
|
textAlign: 'center',
|
|
115
95
|
zIndex: 2,
|
|
116
96
|
}}>
|
|
117
|
-
<h3 className="card-title" style={{ margin: 0 }}>
|
|
97
|
+
<h3 className="card-title" style={{ margin: 0 }}>Mastery Track</h3>
|
|
118
98
|
</div>
|
|
119
99
|
</div>
|
|
120
100
|
|
|
121
|
-
{/* Right Column Card with 3 buttons */}
|
|
122
101
|
<div className={styles.pathCard} style={{ border: '1px solid #4FC86F' }}>
|
|
123
102
|
<div className={styles.cardHeader}>
|
|
124
103
|
<div className={styles.cardIconWrapper}>
|
|
@@ -130,10 +109,11 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
130
109
|
<a href="//docs/academy/MasteryTrack/WorkWithData/ReadingAndWritingThroughTheAPI" className="path-button">Reading & Writing through the API</a>
|
|
131
110
|
<a href="/docs/academy/MasteryTrack/WorkWithData/WorkingWithSubgraphs" className="path-button">Create your own Subgraph</a>
|
|
132
111
|
<a href="/docs/academy/WorkWithData/Analytics Engine/intro" className="path-button">Using the Analytics Engine</a>
|
|
112
|
+
<a href="/docs/academy/WorkWithData/Analytics Engine/intro" className="path-button">Using the Analytics Engine</a>
|
|
133
113
|
</div>
|
|
134
114
|
</div>
|
|
135
115
|
|
|
136
|
-
{/* Launch Card - Full Width with 3 column buttons */}
|
|
116
|
+
{/* Launch Card - Full Width with 3 column buttons - RE-INSERTED */}
|
|
137
117
|
<div className={`${styles.pathCard} ${styles.fullWidth}`}>
|
|
138
118
|
<div className={styles.cardHeader} style={{ justifyContent: 'center' }}>
|
|
139
119
|
<div className={styles.cardIconWrapper}>
|
|
@@ -150,7 +130,7 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
150
130
|
</div>
|
|
151
131
|
</div>
|
|
152
132
|
|
|
153
|
-
{/* Cookbook
|
|
133
|
+
{/* Row 3: Cookbook, Use-cases, Advanced Topics */}
|
|
154
134
|
<div className={styles.pathCard}>
|
|
155
135
|
<div className={styles.cardHeader}>
|
|
156
136
|
<div className={styles.cardIconWrapper}>
|
|
@@ -163,16 +143,25 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
|
|
|
163
143
|
</div>
|
|
164
144
|
</div>
|
|
165
145
|
|
|
166
|
-
{/*
|
|
167
|
-
<div
|
|
146
|
+
{/* Ensure this Use-cases Card block is clean */}
|
|
147
|
+
<div className={styles.pathCard}> {/* New Use-cases Card */}
|
|
148
|
+
<div className={styles.cardHeader}>
|
|
149
|
+
<div className={styles.cardIconWrapper}>
|
|
150
|
+
<img src="/img/academy/icons/Cookbook.svg" alt="Use-cases Icon" />
|
|
151
|
+
</div>
|
|
152
|
+
<h3 className="card-title">Use-cases</h3>
|
|
153
|
+
</div>
|
|
154
|
+
<div className={styles.cardContent}>
|
|
155
|
+
<a href="/docs/academy/ExampleUsecases/Chatroom/SetupBuilderEnvironment" className="path-button">Explore Use-cases</a>
|
|
156
|
+
</div>
|
|
157
|
+
</div>
|
|
168
158
|
|
|
169
|
-
{/* Advanced Topics Card - Right Column */}
|
|
170
159
|
<div className={styles.pathCard}>
|
|
171
160
|
<div className={styles.cardHeader}>
|
|
172
161
|
<div className={styles.cardIconWrapper}>
|
|
173
162
|
<img src="/img/academy/icons/Advanced.svg" alt="" />
|
|
174
163
|
</div>
|
|
175
|
-
<h3 className="card-title">
|
|
164
|
+
<h3 className="card-title">Architecture</h3>
|
|
176
165
|
</div>
|
|
177
166
|
<div className={styles.cardContent}>
|
|
178
167
|
<a href="/academy/05-Architecture/00-PowerhouseArchitecture" className="path-button">Learn More</a>
|
|
@@ -178,7 +178,7 @@ The Powerhouse Design System is a collection of reusable front-end components ba
|
|
|
178
178
|
- Automatic inclusion as a dependency in new Document Model projects
|
|
179
179
|
- Customization options using CSS variables
|
|
180
180
|
|
|
181
|
-
We cover some of these topics in our design system documentation. Read more about the [design system here](/academy/ComponentLibrary/
|
|
181
|
+
We cover some of these topics in our design system documentation. Read more about the [design system here](/academy/ComponentLibrary/DocumentEngineering)
|
|
182
182
|
|
|
183
183
|
## Reactor Libraries
|
|
184
184
|
___
|
|
@@ -1,19 +1,21 @@
|
|
|
1
|
-
# Powerhouse CLI
|
|
1
|
+
# Powerhouse CLI
|
|
2
2
|
|
|
3
3
|
### Installing the Powerhouse CLI
|
|
4
4
|
:::tip
|
|
5
|
-
The Powerhouse CLI tool is the only essential tool to install on this page.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
The **Powerhouse CLI tool** is the only essential tool to install on this page. Install it with the command below.
|
|
6
|
+
You can find all of the commands on this page, similar to what would displayed when using ph --help or ph *command* --help.
|
|
7
|
+
Use the table of content or the search function to find what you are looking for.
|
|
9
8
|
The Powerhouse CLI (`ph-cmd`) is a command-line interface tool that provides essential commands for managing Powerhouse projects. You can get access to the Powerhouse ecosystem tools by installing them globally using:
|
|
9
|
+
|
|
10
10
|
```bash
|
|
11
11
|
pnpm install -g ph-cmd
|
|
12
12
|
```
|
|
13
|
+
:::
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
<!-- AUTO-GENERATED-CLI-COMMANDS-START -->
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
## ph-cmd Commands
|
|
18
|
+
- [Init](#init)
|
|
17
19
|
- [Setup Globals](#setup-globals)
|
|
18
20
|
- [Update](#update)
|
|
19
21
|
- [Use](#use)
|
|
@@ -23,13 +25,13 @@ This tool will be fundamental on your journey when creating, building, and runni
|
|
|
23
25
|
```
|
|
24
26
|
Command Overview:
|
|
25
27
|
The init command creates a new Powerhouse project with optimal defaults. It sets up a fully
|
|
26
|
-
configured project structure with all necessary dependencies, configurations, and boilerplate.
|
|
28
|
+
configured project structure with all necessary dependencies, configurations, and boilerplate.
|
|
27
29
|
|
|
28
30
|
This command:
|
|
29
|
-
1. Creates a new project with the specified name
|
|
30
|
-
2. Installs all required dependencies for Powerhouse development
|
|
31
|
-
3. Sets up a proper project structure and configuration files
|
|
32
|
-
4. Can run in interactive mode for customized setup
|
|
31
|
+
1. Creates a new project with the specified name
|
|
32
|
+
2. Installs all required dependencies for Powerhouse development
|
|
33
|
+
3. Sets up a proper project structure and configuration files
|
|
34
|
+
4. Can run in interactive mode for customized setup
|
|
33
35
|
|
|
34
36
|
Arguments:
|
|
35
37
|
[project-name] Optional. Name of the project to create. If not provided,
|
|
@@ -100,9 +102,9 @@ Options:
|
|
|
100
102
|
|
|
101
103
|
Project Structure:
|
|
102
104
|
The command will set up a project with the following structure:
|
|
103
|
-
- Proper configuration files for TypeScript and ESLint
|
|
104
|
-
- Dependencies for Powerhouse packages
|
|
105
|
-
- Build and development scripts
|
|
105
|
+
- Proper configuration files for TypeScript and ESLint
|
|
106
|
+
- Dependencies for Powerhouse packages
|
|
107
|
+
- Build and development scripts
|
|
106
108
|
|
|
107
109
|
Examples:
|
|
108
110
|
$ ph setup-globals my-project # Create a new project named "my-project"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerhousedao/academy",
|
|
3
|
-
"version": "0.1.0-dev.
|
|
3
|
+
"version": "0.1.0-dev.5",
|
|
4
4
|
"homepage": "https://powerhouse.academy",
|
|
5
5
|
"dependencies": {
|
|
6
6
|
"@codesandbox/sandpack-react": "^2.14.4",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"scripts": {
|
|
38
38
|
"docusaurus": "docusaurus",
|
|
39
39
|
"start": "docusaurus serve",
|
|
40
|
-
"dev": "docusaurus start",
|
|
40
|
+
"dev": "docusaurus start --no-open",
|
|
41
41
|
"build": "NODE_OPTIONS=--max_old_space_size=2048 docusaurus build",
|
|
42
42
|
"swizzle": "docusaurus swizzle",
|
|
43
43
|
"deploy": "docusaurus deploy",
|
package/sidebars.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
|
|
1
|
+
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Creating a sidebar enables you to:
|
|
@@ -97,7 +97,7 @@ const sidebars: SidebarsConfig = {
|
|
|
97
97
|
items: [
|
|
98
98
|
{
|
|
99
99
|
type: 'doc',
|
|
100
|
-
id: 'academy/ComponentLibrary/
|
|
100
|
+
id: 'academy/ComponentLibrary/DocumentEngineering',
|
|
101
101
|
},
|
|
102
102
|
{
|
|
103
103
|
type: 'html',
|
/package/docs/academy/06-ComponentLibrary/{00-PowerhouseDesignSystem.md → 00-DocumentEngineering.md}
RENAMED
|
File without changes
|