@powerhousedao/academy 2.5.0-dev.2 → 2.5.0-dev.21

package/CHANGELOG.md

@@ -1,3 +1,127 @@
+## 2.5.0-dev.21 (2025-06-12)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.20 (2025-06-12)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.19 (2025-06-12)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.18 (2025-06-12)
+
+### 🚀 Features
+
+- added docker publish workflow ([adf65ef8a](https://github.com/powerhouse-inc/powerhouse/commit/adf65ef8a))
+
+### ❤️ Thank You
+
+- Frank
+
+## 2.5.0-dev.17 (2025-06-12)
+
+### 🚀 Features
+
+- show app skeleton while loading and accessibility fixes ([4f96e2472](https://github.com/powerhouse-inc/powerhouse/commit/4f96e2472))
+
+### ❤️ Thank You
+
+- acaldas
+
+## 2.5.0-dev.16 (2025-06-11)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.15 (2025-06-11)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.14 (2025-06-10)
+
+### 🚀 Features
+
+- improved analytics frontend integration ([269aed50c](https://github.com/powerhouse-inc/powerhouse/commit/269aed50c))
+
+### ❤️ Thank You
+
+- acaldas @acaldas
+
+## 2.5.0-dev.13 (2025-06-10)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.12 (2025-06-10)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.11 (2025-06-07)
+
+### 🚀 Features
+
+- **connect:** updated diff-analyzer processor ([ce5d1219f](https://github.com/powerhouse-inc/powerhouse/commit/ce5d1219f))
+
+### ❤️ Thank You
+
+- acaldas
+
+## 2.5.0-dev.10 (2025-06-06)
+
+### 🚀 Features
+
+- run analytics db on web worker ([ecf79575f](https://github.com/powerhouse-inc/powerhouse/commit/ecf79575f))
+
+### ❤️ Thank You
+
+- acaldas
+
+## 2.5.0-dev.9 (2025-06-05)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.8 (2025-06-05)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.7 (2025-06-05)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.6 (2025-06-05)
+
+### 🩹 Fixes
+
+- set node 22 in release branch workflow ([b33681938](https://github.com/powerhouse-inc/powerhouse/commit/b33681938))
+
+### ❤️ Thank You
+
+- Frank
+
+## 2.5.0-dev.5 (2025-06-05)
+
+This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.
+
+## 2.5.0-dev.4 (2025-06-05)
+
+### 🩹 Fixes
+
+- **builder-tools:** move esbuild dev dep to deps ([baa22be6f](https://github.com/powerhouse-inc/powerhouse/commit/baa22be6f))
+
+### ❤️ Thank You
+
+- ryanwolhuter @ryanwolhuter
+
+## 2.5.0-dev.3 (2025-06-05)
+
+### 🚀 Features
+
+- **builder-tools:** add node polyfills esbuild plugin for connect build ([43dd16b4d](https://github.com/powerhouse-inc/powerhouse/commit/43dd16b4d))
+
+### ❤️ Thank You
+
+- ryanwolhuter
+
 ## 2.5.0-dev.2 (2025-06-05)
 
 This was a version bump only for @powerhousedao/academy to align it with other projects, there were no code changes.

package/docs/academy/01-GetStarted/00-ExploreDemoPackage.md

@@ -1,10 +1,20 @@
 # Explore the Demo Package
 
-:::tip
+:::info How Long Will This Tutorial Take?
+We've designed this "Get Started" track to be as smooth as possible. The time it takes will vary based on your familiarity with modern web development tools.
+
+- **For Experienced Developers** (familiar with TypeScript, React, and CLIs), you can expect to complete the entire four-part tutorial in approximately **1 to 1.5 hours**.
+- **For Developers New to This Stack**, we recommend setting aside **3.5 to 4.5 hours**. This allows for time to understand not just the steps, but the core concepts behind them.
+
+This is just a guideline. The goal is to learn comfortably and build a solid foundation with Powerhouse!
+
+A more in theoretic and advanced version of this tutorial can also be found in [Mastery Track - Document Model Creation](../MasteryTrack/DocumentModelCreation/WhatIsADocumentModel).
+:::
+
+
 To give you a quick idea of how the Powerhouse ecosystem operates on document models and packages, why don\'t you try installing a package?   
 
 Install the Powerhouse command-line tool `ph-cmd` and then use it to install a pre-built demo package with document models & editors.
-:::
 
 ## Step 1: Install the Powerhouse CLI
 
@@ -26,7 +36,7 @@ Now, use the `ph` command to install the demo package into a global project.
 
 ```bash
 # Install the package
-ph install contributor-billing
+ph install @powerhousedao/contributor-billing
 ```
 
 This command downloads and sets up the Contributor Billing package, making its features available in your Powerhouse environment.
@@ -34,10 +44,8 @@ This command downloads and sets up the Contributor Billing package, making its f
 You have now successfully installed `ph-cmd` and added your first package! 
 
 :::info 
-WORK IN PROGRESS @callmet
-Let's explore what exactly you can do with this package
-- Document model
-- Drive App
+Let's explore what exactly you can do with this package. 
+At the bottom of the Connect Application you'll find a button with 'invoice'. This allows you to open an invoice document. The invoice document helps contributors to get paid for their work through crypto, stablecoins or a number of other currencies. Contributors can change the state of their invoice from draft to issued, while processors or clients can follow up on the payment of these invoices. In the next steps you can explore this for yourself. 
 :::
 
 ## Step 3: Run the Connect App in Studio mode
@@ -45,7 +53,7 @@ To run the package locally in Connect Studio (our collaboration and contributor
 
 ## Step 4: Log in with Renown
 
-Renown is Powerhouse's decentralized identity and reputation system designed to address the challenge of trust within DAOs, where contributors often operate under pseudonyms. In traditional organizations, personal identity and reputation are key to establishing trust and accountability. Renown replicates this dynamic in the digital space, allowing contributors to earn experience and build reputation without revealing their real-world identities.
+Renown is Powerhouse's decentralized identity and reputation system designed to address the challenge of trust within open organization's, where contributors often operate under pseudonyms. In traditional organizations, personal identity and reputation are key to establishing trust and accountability. Renown replicates this dynamic in the digital space, allowing contributors to earn experience and build reputation without revealing their real-world identities.
 
 :::tip
 When signing in with Renown, use an Ethereum or blockchain address that can function as your \'identity\', as this address will accrue more experience and history over time.
@@ -66,7 +74,7 @@ This DID is then associated with a credential that authorizes a specific Connect
 ### Modify a document
 Switchboard checks the validity of the DID and credential, ensuring the operation request is legitimate. This flow is designed to offer a verifiable, cryptographically secure login system that replaces traditional password-based authentication with decentralized identity and signature-based trust.
 
-## Step 5: Explore the Document Operations History 
+## Step 5: Create an invoice & Explore the Document Operations History 
 
 ![Renown Login](./images/OperationsHistory.png)
 
@@ -77,7 +85,7 @@ Learn more about the [Operations History and other document tools you get for fr
 
 ## Step 6: Export a Document
 
-Export the document as a `.phd` (Powerhouse Document) file using the export button in the document toolbar at the top. In this toolbar, you will find all available functionality for your documents. The `.phd` file can be sent through any of your preferred channels to other users on your Powergrid network. 
+Export the invoice document as a `.phd` (Powerhouse Document) file using the export button in the document toolbar at the top. In this toolbar, you will find all available functionality for your documents. The `.phd` file can be sent through any of your preferred channels to other users on your Powergrid network. 
 
 Now that you have explored a Powerhouse package and discovered its basic functionalities, it is time to start building your own. 
 Our next tutorial focuses on creating a simple To-Do list document and will introduce you to the world of Document Models. 

package/docs/academy/01-GetStarted/01-CreateNewPowerhouseProject.md

@@ -1,7 +1,9 @@
 # Create a ToDoList Document
 
 ## Overview
-This tutorial guides you through creating a 'Powerhouse project' for a **ToDoList**. A Powerhouse project primarily consists of a document model and its editor. You'll be using Connect locally, known as 'Studio mode'.
+This tutorial guides you through creating a simplified version of a 'Powerhouse project' for a **ToDoList**.   
+A Powerhouse project primarily consists of a document model and its editor.   
+For this purpose, you'll be using Connect, our use-centric collaboration tool, locally, known as Connect in 'Studio mode'.
 
 ## Prerequisites
 - Powerhouse CLI installed: `pnpm install -g ph-cmd`
@@ -19,7 +21,9 @@ ph init
 <details>
 <summary> How to make use of different branches? </summary>
 
-When installing or using the Powerhouse CLI commands you are able to make use of the dev & staging branches. These branches contain more experimental features then the latest stable release the PH CLI uses by default. They can be used to get access to a bugfix or features under development.
+When installing or using the Powerhouse CLI commands you are able to make use of the dev & staging branches.   
+These branches contain more experimental features then the latest stable release the PH CLI uses by default.   
+They can be used to get access to a bugfix or features under development.
 
 | Command | Description |
 |---------|-------------|
@@ -43,57 +47,50 @@ Please be aware that these versions can contain bugs and experimental features t
    ```bash
    cd your-directory
    ```
-3. Ensure you're in the correct directory before running the `ph init` command
-
-
+3. Ensure you're in the correct directory before running the `ph init` command.  
 In the terminal, you will be asked to enter the project name. Fill in the project name and press Enter.
+   ```bash
+    you@yourmachine:~/Powerhouse$ ph init
 
-```bash
-you@yourmachine:~/Powerhouse$ ph init
-
-? What is the project name? ‣ <yourprojectname>
-```	
-
-Once the project is created, you will see the following output:
-
-```bash
-Initialized empty Git repository in /Users/yourmachine/<yourprojectname>/.git/
-The installation is done! 
-```
-
-Navigate to the newly created project directory:
-
-```bash
-cd <yourprojectname>
-```
+    ? What is the project name? ‣ <yourprojectname>
+    ```	
 
-Once in the project directory, run the `ph connect` command to start a local instance of the Connect application. This allows you to start your document model specification document.
+    Once the project is created, you will see the following output:
+    ```bash
+    Initialized empty Git repository in /Users/yourmachine/<yourprojectname>/.git/
+    The installation is done! 
+    ```
 
-Run the following command to start the Connect application:
+    Navigate to the newly created project directory:
+    ```bash
+    cd <yourprojectname>
+    ```
+    Once in the project directory, run the `ph connect` command to start a local instance of the Connect application. This allows you to start your document model specification document.
+    Run the following command to start the Connect application:
 
-```bash
-ph connect
-```
+    ```bash
+    ph connect
+    ```
 
-The Connect application will start and you will see the following output:
+    The Connect application will start and you will see the following output:
 
-```bash
-  ➜  Local:   http://localhost:3000/
-  ➜  Network: http://192.168.5.110:3000/
-  ➜  press h + enter to show help
-```
+    ```bash
+      ➜  Local:   http://localhost:3000/
+      ➜  Network: http://192.168.5.110:3000/
+      ➜  press h + enter to show help
+    ```
 
-A new browser window will open and you will see the Connect application. If it doesn't open automatically, you can open it manually by navigating to `http://localhost:3000/` in your browser.
+    A new browser window will open and you will see the Connect application. If it doesn't open automatically, you can open it manually by navigating to `http://localhost:3000/` in your browser.
 
-You will see your local drive and a button to create a new drive. 
+    You will see your local drive and a button to create a new drive. 
 
 :::tip
-A drive is a folder to store and organize your documents in. Powerhouse offers the ability to build customized 'Drive Apps' for your documents. Think of a Drive App as a specialized lens—it offers **different ways to visualize, organize, and interact with** the data stored within a drive, making it more intuitive and efficient for specific use cases. To learn more, visit [Building A Drive App](/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer)
+A **drive** is a folder to store and organize your documents in. Powerhouse offers the ability to build customized 'Drive Apps' for your documents. Think of a Drive App as a specialized lens—it offers **different ways to visualize, organize, and interact with** the data stored within a drive, making it more intuitive and efficient for specific use cases. To learn more, visit [Building A Drive App](/academy/MasteryTrack/BuildingUserExperiences/BuildingADriveExplorer)
 :::
 
-Move into your local drive. 
+Move into your local drive.   
 Create a new document model by clicking the `DocumentModel` button, found in the 'New Document' section at the bottom of the page. 
 
-If you've followed the steps correctly, you'll have an empty document where you can define the 'Document Specifications'.
+If you've followed the steps correctly, you'll have an empty document where you can define the **'Document Specifications'**.
 
 In the next tutorials, you will learn how to specify, add code and build an editor for your document model and export it to be used in your Powerhouse package. 

package/docs/academy/01-GetStarted/02-DefineToDoListDocumentModel.md

@@ -3,13 +3,26 @@
 In this tutorial, you will learn how to define the specifications for a **ToDoList** document model within the Connect application using its GraphQL schema, and then export the resulting document model specification document for your Powerhouse project.
 If you don't have a document specification file created yet, have a look at the previous step of this tutorial to create a new document specification.
 
-Before you start, make sure you have the Connect application running locally with the command `ph connect`
+Before you start, make sure you have the Connect application running locally with the command:
+```bash
+ph connect
+```
+The Connect application will start and you will see the following output:
+
+```bash
+  ➜  Local:   http://localhost:3000/
+  ➜  Network: http://192.168.5.110:3000/
+  ➜  press h + enter to show help
+```
 
 ## ToDoList Document Specification
 
-Likely you have called your project 'ToDoList'. If you've used a different name, please create a new document specification named 'ToDoList'. **Pay close attention to capitalization, as it influences our code.**  
+Likely you have called your project 'ToDoList'.   
+If you've used a different name, please create a new document specification named 'ToDoList'.   
+**Pay close attention to capitalization, as it influences our code.**  
 
-We'll continue with this project to teach you how to create a document model specification and later an editor for your document model. We use the **GraphQL Schema Definition Language** (SDL) to define the schema for the document model. Below, you can see the SDL for the `ToDoList` document model.
+We'll continue with this project to teach you how to create a document model specification and later an editor for your document model. We use the **GraphQL Schema Definition Language** (SDL) to define the schema for the document model.   
+Below, you can see the SDL for the `ToDoList` document model.
 
 :::info
 This schema defines the **data structure** of the document model and the types involved in its operations, which are detailed further as input types.
@@ -17,7 +30,7 @@ Documents in Powerhouse leverage **event sourcing principles**, where every stat
 :::
 
 <details>
-<summary>State Schema of our ToDoList</summary>
+<summary>State Schema of our Simplified ToDoList</summary>
 
 ```graphql
 # The state of our ToDoList
@@ -37,7 +50,7 @@ type ToDoItem {
 
 
 <details>
-<summary>Operations Schema of our ToDoList</summary>
+<summary>Operations Schema of our Simplified ToDoList</summary>
 ```graphql
 # Defines a GraphQL input type for adding a new to-do item
 input AddTodoItemInput {
@@ -63,7 +76,7 @@ input DeleteTodoItemInput {
 
 To be able to define the document model, you need to open the document model editor in Connect. 
 
-#### The steps below show you how to do this:
+### The steps below show you how to do this:
 
 1. In the Connect application, click on **'document model'** to open the document model specification editor.
 2. Name your document model 'ToDoList' in the Connect application, paying close attention to capitalization. 
@@ -93,4 +106,6 @@ Check below screenshot for the complete implementation:
 
 ![ToDoList Document Model](./images/DocumentModelOperations.png)
 
+### Up next: Reducers 
+
 Up next, you'll learn how to implement the runtime logic and components that will use the `ToDoList` document model specification you've just created and exported. 

package/docs/academy/01-GetStarted/03-ImplementOperationReducers.md

@@ -8,8 +8,10 @@ To export the document model specification, follow the steps in the [Define ToDo
 
 Reducers are a core concept in Powerhouse document models. They implement the state transition logic for each operation defined in your schema.
 
+:::info
 **Connection to Schema Definition Language (SDL)**: The reducers directly implement the operations you defined in your SDL. Remember how we defined `AddTodoItemInput`, `UpdateTodoItemInput`, and `DeleteTodoItemInput` in our schema?   
 The reducers provide the actual implementation of what happens when those operations are performed.
+:::
 
 To import the document model specification into your Powerhouse project, you can either: 
 - Copy and paste the file directly into the root of your Powerhouse project.
@@ -19,6 +21,8 @@ Either step will import the document model specification into your Powerhouse pr
 
 ![vscode image](./images/vscode.png)
 
+## In your Project Directory
+
 The next steps will take place in the VSCode editor. Make sure to have it open and the terminal window inside VSCode open as well. 
 
 
@@ -190,4 +194,5 @@ Output should be as follows:
 
 If you got the same output, you have successfully implemented the operation reducers and tests for the **ToDoList** document model. Congratulations, you've successfully set up the backbone for a simple **ToDoList** document. 
 
+## Up Next: ToDoListEditor
 In the next chapter of this introduction 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.