@powerhousedao/academy 2.5.0-dev.3 → 2.5.0-dev.30

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.
Files changed (49) hide show
  1. package/CHANGELOG.md +187 -0
  2. package/docs/academy/01-GetStarted/00-ExploreDemoPackage.md +19 -15
  3. package/docs/academy/01-GetStarted/01-CreateNewPowerhouseProject.md +38 -39
  4. package/docs/academy/01-GetStarted/02-DefineToDoListDocumentModel.md +22 -7
  5. package/docs/academy/01-GetStarted/03-ImplementOperationReducers.md +9 -4
  6. package/docs/academy/01-GetStarted/04-BuildToDoListEditor.md +146 -422
  7. package/docs/academy/01-GetStarted/_04-BuildToDoListEditor +360 -0
  8. package/docs/academy/01-GetStarted/home.mdx +16 -24
  9. package/docs/academy/01-GetStarted/styles.module.css +31 -0
  10. package/docs/academy/02-MasteryTrack/01-BuilderEnvironment/02-StandardDocumentModelWorkflow.md +7 -3
  11. package/docs/academy/02-MasteryTrack/01-BuilderEnvironment/03-BuilderTools.md +1 -1
  12. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/01-WhatIsADocumentModel.md +33 -16
  13. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/02-SpecifyTheStateSchema.md +73 -0
  14. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/03-SpecifyDocumentOperations.md +59 -4
  15. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/04-UseTheDocumentModelGenerator.md +32 -12
  16. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/05-ImplementDocumentReducers.md +103 -38
  17. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/06-ImplementDocumentModelTests.md +90 -228
  18. package/docs/academy/02-MasteryTrack/02-DocumentModelCreation/07-ExampleToDoListRepository.md +41 -1
  19. package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/01-BuildingDocumentEditors.md +342 -67
  20. package/docs/academy/02-MasteryTrack/03-BuildingUserExperiences/02-ConfiguringDrives.md +5 -3
  21. package/docs/academy/02-MasteryTrack/05-Launch/02-PublishYourProject.md +70 -5
  22. package/docs/academy/02-MasteryTrack/05-Launch/03-SetupEnvironment.md +162 -73
  23. package/docs/academy/02-MasteryTrack/05-Launch/{03-RunOnACloudServer.md → _03-RunOnACloudServer} +8 -5
  24. package/docs/academy/04-APIReferences/00-PowerhouseCLI.md +7 -40
  25. package/docs/academy/05-Architecture/00-PowerhouseArchitecture.md +3 -0
  26. package/docs/academy/05-Architecture/images/PowerhouseArchitecture.png +0 -0
  27. package/docs/academy/06-ComponentLibrary/00-DocumentEngineering.md +86 -29
  28. package/docs/academy/06-ComponentLibrary/02-CreateCustomScalars.md +404 -0
  29. package/docs/academy/06-ComponentLibrary/03-IntegrateIntoAReactComponent.md +124 -0
  30. package/docs/academy/07-Cookbook.md +209 -4
  31. package/docs/academy/08-Glossary.md +20 -18
  32. package/docs/academy/09-AIResources +131 -0
  33. package/package.json +1 -1
  34. package/sidebars.ts +3 -45
  35. package/docs/academy/06-ComponentLibrary/02-BuildingWithScalars.md +0 -54
  36. package/docs/academy/06-ComponentLibrary/03-Scalar-Components/01-phid-field.mdx +0 -72
  37. package/docs/academy/06-ComponentLibrary/03-Scalar-Components/02-input-field.mdx +0 -0
  38. package/docs/academy/06-ComponentLibrary/04-Complex-Components/01-sidebar.mdx +0 -36
  39. package/docs/academy/06-ComponentLibrary/05-Layout-Components/01-test-toupdate.mdx +0 -61
  40. package/docs/academy/06-ComponentLibrary/06-Fragments/01-test-toupdate.mdx +0 -61
  41. /package/docs/academy/02-MasteryTrack/05-Launch/{02-IntroductionToPackages.md → 01-IntroductionToPackages.md} +0 -0
  42. /package/docs/academy/02-MasteryTrack/05-Launch/{00-IntegrateInAFront-End → _00-IntegrateInAFront-End} +0 -0
  43. /package/docs/academy/02-MasteryTrack/05-Launch/{01-IntroducingFusion → _01-IntroducingFusion} +0 -0
  44. /package/docs/academy/02-MasteryTrack/05-Launch/{04-GraphQLNamespacing → _04-GraphQLNamespacing} +0 -0
  45. /package/docs/academy/02-MasteryTrack/05-Launch/{05-LaunchYourBackend.md → _05-LaunchYourBackend} +0 -0
  46. /package/docs/academy/02-MasteryTrack/05-Launch/{06-LaunchYourFrontend.md → _06-LaunchYourFrontend} +0 -0
  47. /package/docs/academy/04-APIReferences/{01-ReactHooks.md → 01-ReactHooks} +0 -0
  48. /package/docs/academy/04-APIReferences/{02-ReactorAPI.md → 02-ReactorAPI} +0 -0
  49. /package/docs/academy/04-APIReferences/{03-Configuration.md → 03-Configuration} +0 -0
@@ -1,36 +0,0 @@
1
- import { Tabs, TabItem } from '@theme/Tabs';
2
-
3
- # Sidebar
4
-
5
- ### **Scalar Definition**
6
-
7
- - **Name:** `Sidebar`
8
- - **Purpose:** The Sidebar component can be used within a page layout to provide a sidebar navigation. It provided a tree structure of nodes that can be used to navigate the application offering customization, search and more.
9
-
10
-
11
- <details>
12
- <summary>**Formatting of the component:**</summary>
13
-
14
- </details>
15
-
16
- <details>
17
- <summary>**Validation of the Component:**</summary>
18
-
19
- </details>
20
-
21
- <div style={{
22
- border: '1px solid #E5E7EB',
23
- borderRadius: '8px',
24
- padding: '16px',
25
- marginBottom: '20px',
26
- }}>
27
- <iframe
28
- src="https://dspot-scalars-storybook.vercel.app/iframe.html?args=&id=document-engineering-complex-components-sidebar--readme&viewMode=story"
29
- style={{
30
- width: '100%',
31
- height: '2000px',
32
- border: 'none',
33
- }}
34
- title="Sidebar Component Demo"
35
- />
36
- </div>
@@ -1,61 +0,0 @@
1
- ---
2
- sidebar_label: 'PHID Field'
3
- sidebar_position: 1
4
- ---
5
-
6
- import { Tabs, TabItem } from '@theme/Tabs';
7
-
8
- # PHID Field Example
9
-
10
- ### **Scalar Definition**
11
-
12
- - **Name:** `PHID` (Powerhouse ID)
13
- - **Purpose:** Represents a unique identifier pointing to a document, branch, scope, or data object within the Powerhouse system.
14
-
15
-
16
- <details>
17
- <summary>**Formatting of the component:**</summary>
18
- - **Basic Notation:** `phd:<documentID>`
19
- - **Branch and Scope:** Optional components appended using colons `:`.
20
- - **Full Notation:** `phd:<documentID>:<branch>:<scope>`
21
- - **Branch:** Defaults to `main` if omitted.
22
- - **Scope:** Defaults to `public` if omitted.
23
- - **Data Object Reference:** `phd:<documentID>/<dataObjectID>`
24
- - **URL Format:** `phd://<domain>/<documentID>`
25
- - Example: `phd://switchboard.powerhouse.xyz/baefc2a4-f9a0-4950-8161-fd8d8cc7dea9`
26
-
27
- **Examples of the component formatting:**
28
- - **Basic PHID:** `phd:baefc2a4-f9a0-4950-8161-fd8d8cc7dea9`
29
- - **With Branch:** `phd:baefc2a4...:draft`
30
- - **With Scope:** `phd:baefc2a4...::local`
31
- - **With Branch and Scope:** `phd:baefc2a4...:draft:local`
32
- - **With Data Object ID:** `phd:baefc2a4.../3cf05e40...`
33
- </details>
34
-
35
- <details>
36
- <summary>**Validation of the Component:**</summary>
37
- - **Validate each format:**
38
- 1. **PHID only:** Ensure the document ID is a valid UUID.
39
- 2. **PHID with data element (OID):** Validate both the document ID and the data object ID.
40
- 3. **PHID with branch:** Validate the document ID and check if the branch is properly formatted.
41
- 4. **PHID with scope:** Validate the document ID and check if the scope is valid.
42
- 5. **PHID with branch and scope:** Validate all three components: document ID, branch, and scope.
43
- - **Error Message Example:** "Invalid PHID format. Please check the document ID, branch, or scope."
44
- </details>
45
-
46
- <div style={{
47
- border: '1px solid #E5E7EB',
48
- borderRadius: '8px',
49
- padding: '16px',
50
- marginBottom: '20px',
51
- }}>
52
- <iframe
53
- src="https://dspot-scalars-storybook.vercel.app/iframe.html?args=name:amount-field;placeholder:test;label:Enter%20Amount%20and%20Select%20Currency;type:Amount;placeholderSelect:CUR;allowedTokens:!null;tokenIcons.Sol:1;value.amount:3454564564;value.currency:BTC&id=document-engineering-simple-components-phid-field--readme&viewMode=story"
54
- style={{
55
- width: '100%',
56
- height: '4500px',
57
- border: 'none',
58
- }}
59
- title="PhidField Component Demo"
60
- />
61
- </div>
@@ -1,61 +0,0 @@
1
- ---
2
- sidebar_label: 'PHID Field'
3
- sidebar_position: 1
4
- ---
5
-
6
- import { Tabs, TabItem } from '@theme/Tabs';
7
-
8
- # PHID Field Example
9
-
10
- ### **Scalar Definition**
11
-
12
- - **Name:** `PHID` (Powerhouse ID)
13
- - **Purpose:** Represents a unique identifier pointing to a document, branch, scope, or data object within the Powerhouse system.
14
-
15
-
16
- <details>
17
- <summary>**Formatting of the component:**</summary>
18
- - **Basic Notation:** `phd:<documentID>`
19
- - **Branch and Scope:** Optional components appended using colons `:`.
20
- - **Full Notation:** `phd:<documentID>:<branch>:<scope>`
21
- - **Branch:** Defaults to `main` if omitted.
22
- - **Scope:** Defaults to `public` if omitted.
23
- - **Data Object Reference:** `phd:<documentID>/<dataObjectID>`
24
- - **URL Format:** `phd://<domain>/<documentID>`
25
- - Example: `phd://switchboard.powerhouse.xyz/baefc2a4-f9a0-4950-8161-fd8d8cc7dea9`
26
-
27
- **Examples of the component formatting:**
28
- - **Basic PHID:** `phd:baefc2a4-f9a0-4950-8161-fd8d8cc7dea9`
29
- - **With Branch:** `phd:baefc2a4...:draft`
30
- - **With Scope:** `phd:baefc2a4...::local`
31
- - **With Branch and Scope:** `phd:baefc2a4...:draft:local`
32
- - **With Data Object ID:** `phd:baefc2a4.../3cf05e40...`
33
- </details>
34
-
35
- <details>
36
- <summary>**Validation of the Component:**</summary>
37
- - **Validate each format:**
38
- 1. **PHID only:** Ensure the document ID is a valid UUID.
39
- 2. **PHID with data element (OID):** Validate both the document ID and the data object ID.
40
- 3. **PHID with branch:** Validate the document ID and check if the branch is properly formatted.
41
- 4. **PHID with scope:** Validate the document ID and check if the scope is valid.
42
- 5. **PHID with branch and scope:** Validate all three components: document ID, branch, and scope.
43
- - **Error Message Example:** "Invalid PHID format. Please check the document ID, branch, or scope."
44
- </details>
45
-
46
- <div style={{
47
- border: '1px solid #E5E7EB',
48
- borderRadius: '8px',
49
- padding: '16px',
50
- marginBottom: '20px',
51
- }}>
52
- <iframe
53
- src="https://dspot-scalars-storybook.vercel.app/iframe.html?args=name:amount-field;placeholder:test;label:Enter%20Amount%20and%20Select%20Currency;type:Amount;placeholderSelect:CUR;allowedTokens:!null;tokenIcons.Sol:1;value.amount:3454564564;value.currency:BTC&id=document-engineering-simple-components-phid-field--readme&viewMode=story"
54
- style={{
55
- width: '100%',
56
- height: '4500px',
57
- border: 'none',
58
- }}
59
- title="PhidField Component Demo"
60
- />
61
- </div>