@powerhousedao/academy 3.2.0-dev.2 → 3.2.0-dev.3

package/docs/academy/02-MasteryTrack/04-WorkWithData/03-WorkingWithSubgraphs/03-WorkingWithSubgraphs.md

@@ -1,9 +1,9 @@
-# Working with Subgraphs
+# Working with subgraphs
 
-This tutorial will demonstrate how to create and customize a subgraph using our ToDoList project as an example.
+This tutorial will demonstrate how to create and customize a subgraph using our To-do List project as an example.
 Let's start with the basics and gradually add more complex features and functionality.
 
-## What is a Subgraph?
+## What is a subgraph?
 
 A subgraph in Powerhouse is a **GraphQL-based modular data component** that extends the functionality of your document models. While document models handle the core state and operations, subgraphs can:
 1. Connect to external APIs or databases
@@ -11,19 +11,19 @@ A subgraph in Powerhouse is a **GraphQL-based modular data component** that exte
 3. Automate interactions between different document models
 4. Provide additional backend functionality
 
-### Subgraphs can retrieve data from:
+### Subgraphs can retrieve data from
 
 - **The Reactor** – The core Powerhouse data system or network node.   
 - **Operational Data Stores** – Structured data storage for operational processes, offering real-time updates, for querying structured data.  
 - **Analytics Stores** – Aggregated historical data, useful for insights, reporting and business intelligence.
 
-### Subgraphs consist of:
+### Subgraphs consist of
 
 - **A schema** – Which defines the GraphQL Queries and Mutations.
 - **Resolvers** – Which handle data fetching and logic.
 - **Context Fields** – Additional metadata that helps in resolving data efficiently.
 
-#### Additionaly, context fields allow resolvers to access extra information, such as:
+#### Additionally, context fields allow resolvers to access extra information, such as:
 - **User authentication** (e.g., checking if a user is an admin).
 - **External data sources** (e.g., analytics).
 
@@ -38,9 +38,9 @@ context: {
 }
 ```
 
-## 1. How to generate a subgraph?
+## 1. How to generate a subgraph
 
-Lets start by generating a new subgraph. For our tutorial we will create a new subgraph within our ToDoList project.   
+Lets start by generating a new subgraph. For our tutorial we will create a new subgraph within our To-do List project.   
 Open your project and start your terminal.
 The Powerhouse toolkit provides a command-line utility to create new subgraphs easily.   
 
@@ -55,7 +55,7 @@ Loaded templates: node_modules/@powerhousedao/codegen/dist/codegen/.hygen/templa
       inject: ./subgraphs/index.ts
 ```
 
-### What Happened?
+### What happened?
 1. A new subgraph was created in `./subgraphs/to-do-list-subgraph/`
 2. The subgraph was automatically registered in your project's registry
 3. Basic boilerplate code was generated with an example query
@@ -67,7 +67,7 @@ If we now run 'phreactor' we will see the new subgraph being registered during t
 
 Now that we've generated our subgraph, let's open it and define the schema inside the `index.ts` file.
 
-### 2.1 Define the Schema
+### 2.1 Define the schema
 
 Here we define the schema (typeDefs) which defines the structure of your queries and mutations.
 For educational purposes we will define a simple query that mimics the functionality of the todoList interface (or editor): 
@@ -83,7 +83,7 @@ type Query {
 }
 ```
 
-### What Happened?
+### What happened?
 
 - Added two queries: todoList and todoItems
 - Created an operational table todo_items to store the todo items
@@ -93,7 +93,7 @@ type Query {
 - The todoList query returns the full list with its statistics
 
 
-### 2.2 Implement the Resolver for the subgraph's schema
+### 2.2 Implement the resolver for the subgraph's schema
 Resolvers define how data is retrieved or modified.
 If you query for a specific value you can retrieve the value from either the reactor itself or an operational datastore.    
 We'll look into this in more detail in the next section.
@@ -108,7 +108,7 @@ resolvers: {
 }
 ```
 
-### 2.3 Add Operational Data Storage (Optional)
+### 2.3 Add operational data storage (optional)
 If you need to persist data, initialize an operational datastore inside onSetup():
 
 ```typescript title="Adding an operational datastore"
@@ -126,7 +126,7 @@ async createOperationalTables() {
 }
 ```
 
-### 2.4 Fetching from an Operational Store
+### 2.4 Fetching from an operational store
 If your subgraph interacts with an Operational Data Store, modify the resolver:
 
 ```typescript title="Example of a resolver that fetches data from an operational store"
@@ -139,9 +139,9 @@ resolvers: {
 }
 ```
 
-### 2.5 Connecting to a Processor (Optional, but Recommended)
+### 2.5 Connecting to a processor (optional, but recommended)
 
-#### Why Connect a Processor?
+#### Why connect a processor?
 Subgraphs alone are limited. A subgraph only queries data, but doesn't generate or store it.
 To make subgraphs useful, connect them with processors that update the data dynamically.
 **A processor listens to system events and updates the operational store in real-time.**
@@ -173,9 +173,9 @@ resolvers: {
 }
 ```
 
-## 3. Testing the Subgraph
+## 3. Testing the subgraph
 
-### 3.1. Start the Reactor
+### 3.1. Start the reactor
 To activate the subgraph, run:
 
 ```bash
@@ -187,7 +187,7 @@ Or, for full system startup:
 ph dev 
 ```
 
-### 3.2. Access GraphQL Playground
+### 3.2. Access GraphQL playground
 Open your browser and go to:
 
 ```bash
@@ -199,7 +199,7 @@ Example:
 http://localhost:4001/test-subgraph
 ```
 
-### 3.3. Run a Query
+### 3.3. Run a query
 
 ```graphql
 query {
@@ -207,7 +207,7 @@ query {
 }
 ```
 
-### 3.4. Expected Response
+### 3.4. Expected response
 If everything works, you should see:
 
 ```json
@@ -218,16 +218,16 @@ If everything works, you should see:
 }
 ```
 
-## 4. Working with the Supergraph or Gateway
+## 4. Working with the supergraph or gateway
 
 A supergraph is a GraphQL schema that combines multiple underlying GraphQL APIs, known as subgraphs, into a single, unified graph. This architecture allows different teams to work independently on their respective services (subgraphs) while providing a single entry point for clients or users to query all available data
 
-### 4.1 Key Concepts
+### 4.1 Key concepts
 
 *   **Subgraph:** An independent GraphQL service with its own schema. Each subgraph typically represents a specific domain or microservice within a larger system.
 *   **Gateway/Router:** A server that sits in front of the subgraphs. It receives client queries, consults the supergraph schema, and routes parts of the query to the relevant subgraphs. It then stitches the results back together before sending the final response to the client.
 
-### 4.2 Benefits of Using a Supergraph
+### 4.2 Benefits of using a supergraph
 
 *   **Federated Architecture:** Enables a microservices-based approach where different teams can own and operate their services independently.
 *   **Scalability:** Individual subgraphs can be scaled independently based on their specific needs.
@@ -236,7 +236,7 @@ A supergraph is a GraphQL schema that combines multiple underlying GraphQL APIs,
 *   **Clear Separation of Concerns:** Each subgraph focuses on a specific domain, leading to more maintainable and understandable codebases.
 
 
-### 4.3 Use the Powerhouse Supergraph
+### 4.3 Use the Powerhouse supergraph
 
 The Powerhouse supergraph for any given remote drive or reactor can be found under `http://localhost:4001/graphql`. The gateway / supergraph available on `/graphql` combines all the subgraphs, except for the drive subgraph (which is accessible via `/d/:driveId`). To get to the endpoint open your localhost by starting the reactor and adding `graphql` to the end of the url. The following commands explain how you can test & try the supergraph. 
 
@@ -279,9 +279,9 @@ The supergraph allows to both query & mutate data from the same endpoint.
 This is a quick example of how the supegraph can be used. 
 
 
-## Subgraphs are particularly useful for:
+## Subgraphs are particularly useful for
 
-1. **Cross-Document Interactions**: For example, connecting a ToDoList with an Invoice document model:
+1. **Cross-Document Interactions**: For example, connecting a To-do List with an Invoice document model:
    - When an invoice-related task is marked complete, update the invoice status
    - When an invoice is paid, automatically check off related tasks
 
@@ -300,7 +300,7 @@ This is a quick example of how the supegraph can be used.
 Some subgraphs (e.g., System Subgraph, Drive Subgraph) already exist.  
 To integrate with them, register them via the Reactor API.
 
-### Future Enhancements
+### Future enhancements
 
 Bridge Processors and Subgraphs – Currently, there's a gap in how processors and subgraphs interact. Powerhouse might improve this in future updates.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/04-analytics-processor.md

@@ -1,8 +1,8 @@
-# Analytics Processors
+# Analytics processors
 
 An Analytics Processor is an object that can track analytics for operations and state changes on a set of document models. These analytics can be used to generate bespoke dashboards and reports, specific to the type or implementation of the document model.
 
-## Generating an Analytics Processor with the CLI
+## Generating an analytics processor with the CLI
 
 The `ph-cli` utility can be used to generate the scaffolding for an Analytics Processor.
 
@@ -109,7 +109,7 @@ Model-specific code will go where the `console.log` statement currently resides.
 
 > It is best practice to batch insert all updates to the analytics system. In this example, we add all updates to an array of inputs, then insert them all at once. This is optimal over `await`-ing each separate value.
 
-## Learn By Example: RwaAnalyticsProcessor
+## Learn by example: RwaAnalyticsProcessor
 
 In the `reactor-local` package, we have implemented a processor for the `makerdao/rwa-portfolio` document type. This is a document model that tracks MakerDAO's Real World Asset (RWA) portfolio. It was initially generated using the `ph-cli` utility.
 
@@ -216,7 +216,7 @@ With variables:
 }
 ```
 
-## Learn By Example: Document Operations
+## Learn by example: Document operations
 
 The RWA processor example pulls information from operation _inputs_ to insert analytics data. Another use case might be to capture meta-analytics from the states themselves.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/05-AnalyticsProcessorTutorial/01-SetupBuilderEnvironment.md

@@ -1,4 +1,4 @@
-# Setup Builder Environment
+# Setup builder environment
 
 Let's set up your computer to start with any of the Powerhouse Connect tutorials. Don't worry if this is your first time setting up a development environment - we'll guide you through each step!
 
@@ -6,7 +6,7 @@ Let's set up your computer to start with any of the Powerhouse Connect tutorials
 If you've already setup git, node, and npm, your most important step is to install the Powerhouse CLI with the command `npm install ph-cmd`. A global install is recommended if you want to use the command from any directory as a power user. The Powerhouse CLI is used to create, build, and run your Document Models and give you direct access to a series of Powerhouse ecosystem tools.
 :::
 
-## Table of Contents
+## Table of contents
 - [Prerequisites](#prerequisites)
 - [Installing node.js 22](#installing-nodejs)
   - [For Windows](#for-windows)
@@ -27,11 +27,11 @@ If you've already setup git, node, and npm, your most important step is to insta
 
 Before we begin with any of the Powerhouse Connect tutorials, we need to install some software on your computer. We'll need three main tools: node.js 22, which helps us run our code, Visual Studio Code (VS Code), which is where we'll write our code, and Git, which helps us manage our code. Follow the steps below based on your computer's operating system.
 
-### Installing node.js 22
+### Installing Node.js 22
 
 node.js 22 is a tool that lets us run our application. Let's install it step by step.
 
-#### For Windows:
+#### For Windows
 1. **Set up PowerShell for running commands:**
    - Press the Windows key
    - Type "PowerShell"
@@ -60,7 +60,7 @@ node.js 22 is a tool that lets us run our application. Let's install it step by
 
 > **Note**: If node.js 22 commands don't work in VS Code, restart VS Code to refresh environment variables.
 
-#### For macOS:
+#### For macOS
 1. **Install Homebrew:**
    - Open Terminal (press Command + Space and type "Terminal")
    - Copy and paste this command into Terminal and press Enter:
@@ -83,7 +83,7 @@ node.js 22 is a tool that lets us run our application. Let's install it step by
    ```
    - If you see version numbers, you've successfully installed node.js 22!
 
-#### For Linux (Ubuntu/Debian):
+#### For Linux (Ubuntu/Debian)
 1. **Open Terminal:**
    - Press Ctrl + Alt + T on your keyboard, or
    - Click the Activities button and type "Terminal"
@@ -110,7 +110,7 @@ node.js 22 is a tool that lets us run our application. Let's install it step by
 
 VS Code is the editor we'll use to write our code. Here's how to install it:
 
-#### For Windows:
+#### For Windows
 1. Visit the [Visual Studio Code website](https://code.visualstudio.com/)
 2. Click the blue "Download for Windows" button
 3. Once the installer downloads, double-click it
@@ -120,7 +120,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
 7. Click "Next" and then "Install"
 8. When installation is complete, click "Finish"
 
-#### For macOS:
+#### For macOS
 1. Visit the [Visual Studio Code website](https://code.visualstudio.com/)
 2. Click the blue "Download for Mac" button
 3. Once the .zip file downloads, double-click it to extract
@@ -131,7 +131,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
    - Press Command + Shift + P
    - Type "shell command" and select "Install 'code' command in PATH"
 
-#### For Linux (Ubuntu/Debian):
+#### For Linux (Ubuntu/Debian)
 1. Open Terminal (Ctrl + Alt + T)
 2. First, update the packages list:
    ```bash
@@ -159,7 +159,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
 
 ### Install Git
 
-#### Windows
+#### For Windows
 1. Open PowerShell (press Windows key, type "PowerShell", and press Enter)
 2. Visit the [Git website](https://git-scm.com/)
 3. Download the latest version for Windows
@@ -169,7 +169,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
    git --version
    ```
 
-#### macOS
+#### For macOS
 1. Install using Homebrew:
    ```bash
    brew install git
@@ -179,7 +179,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
    git --version
    ```
 
-#### Linux (Ubuntu/Debian)
+#### For Linux (Ubuntu/Debian)
 1. Update package list:
    ```bash
    sudo apt update
@@ -193,7 +193,7 @@ VS Code is the editor we'll use to write our code. Here's how to install it:
    git --version
    ```
 
-### Configure Git (All Systems)
+### Configure Git (all systems)
 
 Open your terminal (command prompt) and run the following commands to set up Git:
 
@@ -203,7 +203,7 @@ git config --global user.name "Your Name"
 git config --global user.email "your.email@example.com"
 ```
 
-### Verify Installation
+### Verify installation
 
 Open your terminal (command prompt) and run the following commands to verify your setup:
 ```bash

package/docs/academy/02-MasteryTrack/04-WorkWithData/05-AnalyticsProcessorTutorial/02-CreateNewPowerhouseProject.md

@@ -1,4 +1,4 @@
-# Create New Powerhouse Project
+# Create new Powerhouse project
 
 Before we start diving into the tutorial, lets have a quick look at all the steps we'll go through. 
 
@@ -16,7 +16,7 @@ Let's start with step 1 & 2 in the next section of the tutorial!
 
 To create a new Powerhouse Document Model Library project, you can use the `ph init` command in your terminal. This command will create a new project in the current directory.
 
-## Create New Powerhouse Document Model Library Project
+## Create new Powerhouse document model library project
 
 :::info
 This command will create a new project in the current directory.

package/docs/academy/02-MasteryTrack/04-WorkWithData/05-AnalyticsProcessorTutorial/03-GenerateAnAnalyticsProcessor.md

@@ -1,6 +1,6 @@
-# Generate the Reactor & Analytics Processor
+# Generate the reactor and analytics processor
 
-### Launch the Reactor
+### Launch the reactor
 
 **First**, navigate to the project directory with `cd rwa-analytics` to start the reactor from the project directory.
 Now open the directory with your code editor with the command `code . `
@@ -24,7 +24,7 @@ Next, launch the reactor by running the following command in your terminal.
 
 As you can see the reactor registered the default system subgraph but also the `d/:drive` subgraph for fetching documents and pushing updates. It also registered the analytics subgraph, which we'll use later for running analytics queries on the document model in the next steps. 
 
-### Generate the Analytics Processor
+### Generate the analytics processor
 **Next** we'll open up a second terminal window and generate the analytics processor.
 Use the following command to generate the analytics processor in a seperate terminal window.
 ```bash
@@ -34,7 +34,7 @@ In your project directory you'll now see the folder 'processors' being created.
 Later we'll see how this processor is actively listening for the operations on a document model.
 Eventually we'll replace the default code of the generated processor with our own custom analytics processor code to listen to specific operations, dimensions and metrics.
 
-### Add data to the document model in the Reactor
+### Add data to the document model in the reactor
 
 Now that we've generated the analytics processor we need to give it some data to listen to.
 For this we've created the local reactor instance, which will represent a node in the Powerhouse network. 
@@ -111,7 +111,7 @@ Click on the 'Save' button to save the transaction.
 
 You'll now see the transaction appear in the transaction table.
 
-### Let's buy & sell some T-bills!
+### Let's buy and sell some T-bills!
 
 Now that we've created the T-bill asset and took out a loan from Sky to purchase it, we can start buying some T-bills. 
 Let's buy 2,500,000 T-bills for $2,490,000 on May 15.
@@ -157,7 +157,7 @@ Your table of transactions should now look like this:
 
 ![RWA Portfolio](./images/Transaction-table.png)
 
-### Verify that the document data is correctly entered & inspect the document history		
+### Verify that the document data is correctly entered and inspect the document history		
 
 Connect offers you with a few ways to inspect the document data and history. Click on the 'revision history' button in the top right corner of your document model in Connect to see the history of your operations on the document model.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/05-AnalyticsProcessorTutorial/04-UpdateAnalyticsProcessor.md

@@ -1,4 +1,4 @@
-# Update the Analytics Processor
+# Update the analytics processor
 
 Now let's implement our custom analytics processor code to calculate the total value of the asset class on a monthly basis.
 You will likely already be in the desired directory, but if not, navigate to the project directory and open it.

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/GraphQL References/QueryingADocumentWithGraphQL.md

@@ -16,7 +16,7 @@ We will show how you can receive:
 > #### 2. Only the latest changes and updates:
 > Or specific operations of a document by registering a listener with a specific filter.
 
-### Adding the specific Document Drive to Connect with an URL
+### Adding the specific document drive to Connect with a URL
 
 The specific drive where your RWA-report or any other document is being stored can be accessed through Connect. Connect functions as your decentralised document drive to access and edit document models that capture the data present in your organisation.
 
@@ -44,7 +44,7 @@ It extracts common fields such as id, name, documentType, revision, created, and
 
 Additionally, it retrieves specific data related to the 'Real World Assets' document model, including accounts, SPVs, fixed income types, fee types, portfolio, and transactions. The RWA section of the query is designed to pull in detailed information about the financial structure and transactions of real-world assets managed within the document model.
 
-#### Common Document Fields
+#### Common document fields
 
 - `name`: The name of the document.
 - `documentType`: The type classification of the document.

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/best-practices.md

@@ -2,13 +2,13 @@
 sidebar_position: 1000
 ---
 
-# Best Practices
+# Best practices
 
 ### GraphQL
 
 **Start general, end with detailed queries.** In the case you want to find a specific number for a specific metric and dimension, the rule of thumb is to start general in the filter definitions and slowly start cutting down the paths to a particular team or budget period.
 
-For example: Looking at the dimension section in the filter options: To see available sub paths for the budget, leave the select: "atlas" and lod as 5 . With lod:5 you’ll be able to see the different paths available under your defined filter. Then, later you can apply a more detailed path in the select: "atlas/..." path that will suit your needs.
+For example: Looking at the dimension section in the filter options: To see available sub paths for the budget, leave the select: "atlas" and lod as 5 . With lod:5 you'll be able to see the different paths available under your defined filter. Then, later you can apply a more detailed path in the select: "atlas/..." path that will suit your needs.
 
 ```graphql
 {
@@ -30,7 +30,7 @@ For example: Looking at the dimension section in the filter options: To see avai
 
 **Fetch per specified path** if performance is an issue.
 
-### Guidelines for Selecting and Combining Dimensions
+### Guidelines for selecting and combining dimensions
 
 1. **Understand the Purpose of Analysis**  
 Before selecting dimensions, clarify the objective of your analysis. Are you looking to track expenses for a specific project, analyze budget utilization, or examine transaction patterns? Your objective will guide which dimensions are most relevant.
@@ -54,7 +54,7 @@ While combining dimensions can provide depth, avoid overly complex combinations
 Where icons are available, they can be used as a quick visual reference to identify different dimensions or categories, particularly in user interfaces where rapid identification is beneficial.
 
 8. **Experiment and Iterate**  
-Don’t hesitate to experiment with different combinations of dimensions to see which provide the most meaningful insights. The flexibility of the dimensions allows for various permutations and combinations to suit diverse analytical needs.
+Don't hesitate to experiment with different combinations of dimensions to see which provide the most meaningful insights. The flexibility of the dimensions allows for various permutations and combinations to suit diverse analytical needs.
 
 9. **Stay Updated**  
 Keep abreast of any changes or additions to the dimensions within the analytics engine, as this can impact ongoing and future analyses.

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/graphql/index.md

@@ -6,7 +6,7 @@ sidebar_position: 3
 
 A basic understanding of GraphQL is helpful to understand this document, as we use concepts and vocabulary from the broader ecosystem. For a good primer on the subject, see the [Introduction to GraphQL](https://graphql.org/learn/).
 
-## Basic GraphQL Structure:
+## Basic GraphQL structure
 
 - **Query**: At its core, a GraphQL query is about asking or 'querying' for specific fields on objects. The query is structured like a JSON object, but without the values. This structure lets you specify exactly which data you want to fetch from the server.
 
@@ -33,7 +33,7 @@ query {
 In this example, query is the operation type, user is the field on the root type, and name, email, and friends are fields on the user type. The id: `"1"` is a parameter passed to the query, specifying which user to fetch.
 You can find more examples of GraphQL core concept in the section [GraphQL at Powerhouse](/academy/MasteryTrack/WorkWithData/GraphQLAtPowerhouse).
 
-## Analytics Query Structure
+## Analytics query structure
 
 In the GraphQL query for the Analytics Engine below, each element requests specific pieces of data from the analytics API. Here is a breakdown of the fields and elements with a dropdown with their descriptions below.
 
@@ -102,7 +102,7 @@ This query structure allows users to extract detailed and summarized analytics d
 
 In the analytics engine, the filter object in a GraphQL query is crucial for tailoring the data retrieval to specific requirements. For the query to function correctly, a complete and fully structured filter object, containing all necessary parameters, must be used. Here's a guide on how to construct these filter objects and examples of different filter configurations.
 
-### Constructing a Complete Filter Object
+### Constructing a complete filter object
 
 A filter object must include all the following parameters:
 
@@ -133,7 +133,7 @@ The level of detail (`lod`) Parameter
     - **Impact on Analysis**: The level of detail can significantly affect the analysis. For instance, a high lod can provide in-depth insights into a specific area, useful for detailed audits or close examination of a particular segment. Conversely, a low lod is better for broader overviews or when comparing larger categories.
 
 Importance of Correct Configuration
-    - **Accuracy of Results**: Setting the correct path in the select field and aligning it with an appropriate lod ensures the accuracy and relevance of the query results. Incorrect or mismatched configurations might lead to misleading insights or data that doesn’t serve the intended analytical purpose.
+    - **Accuracy of Results**: Setting the correct path in the select field and aligning it with an appropriate lod ensures the accuracy and relevance of the query results. Incorrect or mismatched configurations might lead to misleading insights or data that doesn't serve the intended analytical purpose.
     - **Customized Analysis**: Together, the select field and lod allow for a high degree of customization in data queries. Users can tailor their data requests precisely to their specific requirements, whether they need a broad overview or a detailed breakdown.
     - Follow the right upper or lower case letter style from metrics, granularity and dimensions.
 
@@ -149,15 +149,15 @@ The filter object can be created by using the UI menu from the graphql apollo st
 
 ## Troubleshooting
 
-### Common Issues
+### Common issues
 
 **Mistyping the filter options or not using proper upper or lower case when necessary.** Make sure to check this first when running into problems
 
-### Error Messages
+### Error messages
 
 Usually, error messages are explicit and easy to understand what is wrong, below you can find some examples.
 
-- `"message": "Cannot read properties of undefined (reading 'filter')"`, → There is something wrong with the filter options, make sure you’ve added all fields in the filter options.
+- `"message": "Cannot read properties of undefined (reading 'filter')"`, → There is something wrong with the filter options, make sure you've added all fields in the filter options.
 
 - `"message": "No valid metrics provided, make sure to use metrics from this list: Actuals, Budget, Forecast, FTEs, PaymentsOffChainIncluded, PaymentsOnChain, ProtocolNetOutflow"`, → A wrong format when adding metrics
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/graphql/integration.md

@@ -6,7 +6,7 @@ sidebar_position: 1
 
 The `analytics-engine-graphql` module provides types and resolvers needed for a fully-functional GraphQL Server API. This library has no dependencies on any particular server but has been tested using [Apollo Server 3 and 4](https://www.apollographql.com/docs/apollo-server).
 
-## Resolvers and Types
+## Resolvers and types
 
 The graphql package contains typical resolvers and typedefs. The resolvers, however, are dependent on another object: `AnalyticsModel`. This object is responsible for connecting GQL types with an `IAnalyticsStore` implementation.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/intro.md

@@ -2,7 +2,7 @@
 sidebar_position: 0
 ---
 
-# Getting Started
+# Getting started
 
 ## Introduction
 
@@ -16,7 +16,7 @@ This documentation serves as a guide for Typescript and GraphQL API usage, not l
 
 This system can be broken up into several major systems: **queries**, **engine components** (including filters and aggregation), and **storage**. Each of these systems have detailed documentation, but it is most helpful to start with a holistic understanding of the major pieces of data: series and dimensions.
 
-### Series and Dimensions
+### Series and dimensions
 
 All metrics are collected and stored using only two objects: **AnalyticsSeries** and **AnalyticsDimension**. To be a successful consumer of this system, It is vital to understand the intent of these two pieces of data.
 
@@ -52,7 +52,7 @@ Visually, you can think of series as values running up and down, while dimension
 
 ![6](./images/overview-6.jpg)
 
-### Structure v Reporting
+### Structure vs. reporting
 
 The Series and Dimensions objects give control over how metric data is defined and related. That is, they define the **structure** of data. Three new concepts: Paths, LODs, and granularity, are parameters used to define how the system should _report_ the data.
 
@@ -94,7 +94,7 @@ An LOD greater than the number of parts of the path (in this case, 4 or more) wi
 
 While LODs allow you to aggregate series data across dimensions, _granularity_ refers to how data is aggregated over time. It determines the time span each data point or record covers. Choosing the right granularity is crucial for meaningful analysis, as it affects the interpretation and insights that can be drawn from the data.
 
-#### Available Options
+#### Available options
 
 The analytics engine supports various granularity options, each suitable for different types of analysis:
 
@@ -113,7 +113,7 @@ daily: Offers a day-to-day breakdown, ideal for detailed analysis of daily opera
 
 7. `hourly`: The most granular level, providing insights into hourly fluctuations. Useful in scenarios where short-term data spikes or dips are significant.
 
-#### How Granularity Affects Query Results
+#### How granularity affects query results
 
 - Data Volume: Higher granularity (like hourly or daily) results in a larger volume of data points, providing more detailed insights but potentially leading to more complex analysis. Lower granularity (like annual or total) simplifies the data into fewer, broader data points.
 
@@ -140,7 +140,7 @@ These are high-level definitions of major terms you will need to know.
 
 * **Granularity** - Determines how to aggregate values over time, like "monthly" or "yearly".
 
-## Next Steps
+## Next steps
 
 Next steps depend on use case.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/typescript/browser.md

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# Browser Store
+# Browser store
 
 The `BrowserAnalyticsStore` is an `IAnalyticsStore` implementation that sits on top of [`MemoryAnalyticsStore`](#memory) but adds an `IndexedDB` plugin for persistence.
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/typescript/index.md

@@ -16,7 +16,7 @@ The `core` library contains common data types and abstractions used throughout.
 
 The `knex`, `pg`, and `browser` libraries contain various storage implementations. Finally, the `graphql` library contains types, resolvers, and data types for a GraphQL API on top.
 
-## Querying Data
+## Querying data
 
 The entry point for data queries in Typescript is the `AnalyticsQueryEngine`. This wraps an `IAnalyticsStore` implementation, which will be discussed in detail later.
 
@@ -121,7 +121,7 @@ type GroupedPeriodResult = {
 
 - `sum`: A total or aggregated value of the metric over the entire period, providing a summarized figure.
 
-### A Note about Times
+### A note about times
 
 Time is a bit of a sore subject in JavaScript, and we wrestled a bit with how to attack this problem.
 
@@ -133,7 +133,7 @@ As this is a time-series analytics system, times are rather important to get rig
 
 This is why our analytics API uses these luxon types as inputs and outputs to the system: to make it hard to screw up.
 
-## Inserting Data
+## Inserting data
 
 The `IAnalyticsStore` interface is the primary entry point for inserting and deleting data. Multiple storage implementations are provided, but for simplicity we can get up and running quickly with the [`MemoryAnalyticsStore`](#memory).
 
@@ -168,7 +168,7 @@ await store.addSeriesValue([
 ]);
 ```
 
-## Subscribing to Data Changes
+## Subscribing to data changes
 
 The `IAnalyticsStore` also provides an API for subscribing to data changes. This is achieved by subscribing to an `AnalyticsPath`.
 
@@ -221,7 +221,7 @@ await store.addSeriesValue({ source: AnalyticsPath.fromString("atlas/foo/test/a/
 await store.addSeriesValue({ source: AnalyticsPath.fromString("rwa/foo/test"), ... });
 ```
 
-## Store Implementations
+## Store implementations
 
 Multiple storage implementations are provided, each with comprehensive documentation. See the corresponding docs for:
 

package/docs/academy/02-MasteryTrack/04-WorkWithData/06-Analytics Engine/typescript/memory.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# Memory Store
+# Memory store
 
 The `MemoryAnalyticsStore` is an `IAnalyticsStore` implementation that uses a an in-memory database as its storage mechanism. Under the hood, we load a WASM build of Postgres, called [PGlite](https://pglite.dev/).