Skip to content

Commit 5d02b28

Browse files
MearmanMearman
authored
Merge pull request #31 from ExaDev/add-board-tag-and-reorganise
add board tags where appropriate and reorganise breadboard examples
2 parents 62b1a79 + b9ee64b commit 5d02b28

38 files changed

+281
-150
lines changed

‎.github/workflows/build.yaml

+30-27
Original file line numberDiff line numberDiff line change
@@ -64,33 +64,36 @@ jobs:
6464
path: public
6565
name: public
6666

67-
preview:
68-
name: Preview when PR exists branch
69-
runs-on: ubuntu-latest
70-
needs: build
71-
if: github.event_name == 'pull_request' && github.event.action != 'closed'
72-
steps:
73-
- name: Check out the repo
74-
uses: actions/checkout@v4
75-
with:
76-
fetch-depth: 0
77-
78-
- name: Get artifacts from build job
79-
uses: actions/download-artifact@v4
80-
with:
81-
name: public
82-
path: public
83-
84-
- uses: actions/upload-pages-artifact@v3
85-
with:
86-
path: public
87-
name: pages
88-
89-
- name: Deploy to GitHub Pages
90-
uses: actions/deploy-pages@v4
91-
with:
92-
artifact_name: pages
93-
preview: true
67+
# preview:
68+
# name: Preview when PR exists branch
69+
# runs-on: ubuntu-latest
70+
# needs: build
71+
# if: github.event_name == 'pull_request' && github.event.action != 'closed'
72+
# permissions:
73+
# id-token: write
74+
# pages: write
75+
# steps:
76+
# - name: Check out the repo
77+
# uses: actions/checkout@v4
78+
# with:
79+
# fetch-depth: 0
80+
81+
# - name: Get artifacts from build job
82+
# uses: actions/download-artifact@v4
83+
# with:
84+
# name: public
85+
# path: public
86+
87+
# - uses: actions/upload-pages-artifact@v3
88+
# with:
89+
# path: public
90+
# name: pages
91+
92+
# - name: Deploy to GitHub Pages
93+
# uses: actions/deploy-pages@v4
94+
# with:
95+
# artifact_name: pages
96+
# preview: true
9497

9598
deploy:
9699
if: github.ref == 'refs/heads/main'

‎content/projects/Breadboard/Phase 2/BGL JSX.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ tags:
55
- breadboard/phase/2
66
- JSX
77
- XML
8+
- board
89
created: 2024-05-30T11:44:38
910
modified: 2024-06-12T10:34:25
1011
---
@@ -17,13 +18,13 @@ e.g.
1718

1819
```tsx
1920
<board>
20-
<nodes>
21-
<node id="input-1" type="input" />
22-
<node id="output-1" type="output" />
23-
</nodes>
24-
<edges>
25-
<edge from="input-1" out="say" to="output-1" in="hear" />
26-
</edges>
21+
<nodes>
22+
<node id="input-1" type="input" />
23+
<node id="output-1" type="output" />
24+
</nodes>
25+
<edges>
26+
<edge from="input-1" out="say" to="output-1" in="hear" />
27+
</edges>
2728
</board>
2829
```
2930

‎content/projects/Breadboard/Phase 2/Board for Each.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- breadboard
99
- breadboard/phase/2
1010
- utility
11+
- board
1112
created: 2024-06-13T16:07:02
1213
modified: 2024-06-21T08:17:02
1314
---
@@ -19,6 +20,7 @@ This Board allows for data manipulation by processing arrays with custom logic b
1920
Whether you're dealing with text, numbers, or other data types, the "Board for Each" makes it easy to apply transformations and achieve the desired output.
2021

2122
**The Functionality**:
23+
2224
- **Input**: An array of items and a logic board.
2325
- **Output**: Processed array with transformations applied to each item.
2426

@@ -27,13 +29,13 @@ For example, given the array containing the phrase "The quick brown fox" with it
2729
## How It Works
2830

2931
1. **Initial Setup**:
30-
- The logic board can accept various inputs, including whole boards or specific data arrays.
32+
- The logic board can accept various inputs, including whole boards or specific data arrays.
3133
2. **Code Implementation**:
32-
- The board operates by evaluating each item in the input array.
33-
- A ternary operation within the logic board determines whether to change the case of each character.
34+
- The board operates by evaluating each item in the input array.
35+
- A ternary operation within the logic board determines whether to change the case of each character.
3436
3. **Execution Process**:
35-
- The board processes each item in the array individually.
36-
- Results are accumulated and emitted once all items are processed.
37+
- The board processes each item in the array individually.
38+
- Results are accumulated and emitted once all items are processed.
3739

3840
## Practical Example
3941

‎content/projects/Breadboard/Phase 2/Breadboard Chrome Extension/Reusable Boards.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Sentiment Analysis Breadboard Chrome Extension
3+
aliases: []
4+
tags:
5+
- breadboard/phase/2
6+
- Chrome
7+
- chrome_extension
8+
- React
9+
- sentiment
10+
- Vite
11+
- board
12+
created: 2024-06-25T11:35:15
13+
---
14+
15+
## Reusable Boards
16+
17+
- [Claude summary](https://github.com/ExaDev/breadboard/blob/claude-summarisation-board-test/packages/breadboard-chrome-extension/src/breadboard/graphs/claudeBoard.json)
18+
[🔗](https://breadboard-ai.web.app/?board=https%3A%2F%2Fraw.githubusercontent.com%2FExaDev%2Fbreadboard%2Fclaude-summarisation-board-test%2Fpackages%2Fbreadboard-chrome-extension%2Fsrc%2Fbreadboard%2Fgraphs%2FclaudeBoard.json)
19+
20+
This board generates a summary for a given text using the Claude API.
21+
22+
- [Sentiment analysis](https://github.com/ExaDev/breadboard/blob/breadboard-sentiment-analysis-chrome-extension/packages/breadboard-chrome-extension/src/breadboard/graphs/sentimentBoard.json)
23+
[🔗](https://breadboard-ai.web.app/?mode=build&board=https%3A%2F%2Fraw.githubusercontent.com%2FExaDev%2Fbreadboard%2Fbreadboard-sentiment-analysis-chrome-extension%2Fpackages%2Fbreadboard-chrome-extension%2Fsrc%2Fbreadboard%2Fgraphs%2FsentimentBoard.json)
24+
25+
This board gets sentiment for a given text and uses the Hugging Face Inference API.
26+
27+
> [!note] For [Sentiment Analysis](projects/Breadboard/Phase%202/Breadboard%20Chrome%20Extension/Sentiment%20Analysis.md) and [[Text Labelling]], a Hugging Face API key can be generated for free [here](https://huggingface.co/settings/tokens).

‎content/projects/Breadboard/Phase 2/Breadboard Chrome Extension/index.md

-9
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,3 @@ The most up-to-date and stable version of this project, that uses the Claude API
3434
- [breadboard-sentiment-analysis-chrome-extension](https://github.com/ExaDev/breadboard/tree/breadboard-sentiment-analysis-chrome-extension/packages/breadboard-chrome-extension)
3535

3636
This follows the same structure as the summariser, but the focus here was to integrate a board that performs sentiment analysis on a selected piece of text.
37-
38-
## Reusable Boards
39-
40-
- [Claude summary](https://github.com/ExaDev/breadboard/blob/claude-summarisation-board-test/packages/breadboard-chrome-extension/src/breadboard/graphs/claudeBoard.json)
41-
[🔗](https://breadboard-ai.web.app/?board=https%3A%2F%2Fraw.githubusercontent.com%2FExaDev%2Fbreadboard%2Fclaude-summarisation-board-test%2Fpackages%2Fbreadboard-chrome-extension%2Fsrc%2Fbreadboard%2Fgraphs%2FclaudeBoard.json)
42-
- [Sentiment analysis](https://github.com/ExaDev/breadboard/blob/breadboard-sentiment-analysis-chrome-extension/packages/breadboard-chrome-extension/src/breadboard/graphs/sentimentBoard.json)
43-
[🔗](https://breadboard-ai.web.app/?mode=build&board=https%3A%2F%2Fraw.githubusercontent.com%2FExaDev%2Fbreadboard%2Fbreadboard-sentiment-analysis-chrome-extension%2Fpackages%2Fbreadboard-chrome-extension%2Fsrc%2Fbreadboard%2Fgraphs%2FsentimentBoard.json)
44-
45-
> [!note] For [Sentiment Analysis](projects/Breadboard/Phase%202/Breadboard%20Chrome%20Extension/Sentiment%20Analysis.md) and [[Text Labelling]], a Hugging Face API key can be generated for free [here](https://huggingface.co/settings/tokens).

‎content/projects/Breadboard/Phase 2/Examples.md

-36
This file was deleted.

‎content/projects/Breadboard/Phase 2/Examples/Code Nodes.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Code Nodes
3+
aliases:
4+
- Boards using code node
5+
tags:
6+
- breadboard/phase/2/Examples
7+
- documentation
8+
- board
9+
created: 2024-05-30T11:42:12
10+
---
11+
12+
- [code-node-dynamic](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/code-node-dynamic)
13+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/code-node-dynamic/graph.json)
14+
Example of a board using xenova/transformers library via dynamic import.
15+
16+
- [code-node](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/code-node)
17+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/code-node/graph.json)
18+
Sample usage of code nodes both inside and outside of the board. These code nodes are used to create kits for modifying strings such as: transforming text into uppercase, concatenating, and reversing.

‎content/projects/Breadboard/Phase 2/Examples/Harness with Diagnostics.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Harness with Diagnostics
3+
tags:
4+
- breadboard/phase/2/Examples
5+
- documentation
6+
- board
7+
created: 2024-05-30T11:42:12
8+
---
9+
10+
- [harness-with-diagnostics](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/harness-with-diagnostics)
11+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/harness-with-diagnostics/graph.json)

‎content/projects/Breadboard/Phase 2/Examples/Hello World.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Hello World
3+
aliases:
4+
- Basic hello world board
5+
tags:
6+
- breadboard/phase/2/Examples
7+
- documentation
8+
- board
9+
created: 2024-05-30T11:42:12
10+
---
11+
12+
- [hello-world](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/hello-world)
13+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/hello-world/graph.json)
14+
Simple board that takes a message of type string as input, wires the message to the board's output, then logs the result to the console.

‎content/projects/Breadboard/Phase 2/Examples/Inputs and Outputs.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Using inputs and outputs
3+
tags:
4+
- breadboard/phase/2/Examples
5+
- documentation
6+
- board
7+
created: 2024-05-30T11:42:12
8+
---
9+
10+
- [multiple-inputs-one-output](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/multiple-inputs-one-output)
11+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/multiple-inputs-one-output/graph.json)
12+
Simple board that creates three different inputs and wires them to a single output.
13+
14+
- [one-input-multiple-outputs](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/one-input-multiple-outputs)
15+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/one-input-multiple-outputs/graph.json)
16+
Simple board that creates a single input with two "steps" which are then wired to two different outputs. The first part and second part of the input are wired to output-1 and output-2 respectively.

‎content/projects/Breadboard/Phase 2/Examples/Making Kits.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Making kits
3+
aliases:
4+
- Creating a kit
5+
tags:
6+
- breadboard/phase/2/Examples
7+
- documentation
8+
- board
9+
created: 2024-05-30T11:42:12
10+
---
11+
12+
- [making-a-kit](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/making-a-kit)
13+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/making-a-kit/graph.json)
14+
Board implementing a string manipulation kit using [KitBuilder](https://github.com/breadboard-ai/breadboard/blob/main/packages/breadboard/src/kits/builder.ts).
15+
- [kit-with-code-node](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/kit-with-code-node)
16+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/kit-with-code-node/graph.json)
17+
Board implementing xenovaPipe kit using KitBuilder and the code node.

‎content/projects/Breadboard/Phase 2/Examples/Running Serialized Board.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Running serialized board with code node
3+
aliases:
4+
- Creating a kit
5+
tags:
6+
- breadboard/phase/2/Examples
7+
- documentation
8+
- board
9+
created: 2024-05-30T11:42:12
10+
---
11+
12+
- [running-serialized-board-with-code-node](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/running-serialized-board-with-code-node)
13+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/running-serialized-board-with-code-node/graph.json)
14+
This is a board that uses code nodes for manipulating strings such as: transforming to uppercase, concatenating and reversing. The board is called by creating a new [Board Runner](https://github.com/breadboard-ai/breadboard/blob/748e3c55e9e8896c4e5ede3b606ee81b66ec10a5/packages/breadboard/src/runner.ts) instance and calling its' runOnce method.

‎content/projects/Breadboard/Phase 2/Examples/Wiring Nodes.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Wiring nodes
3+
tags:
4+
- breadboard/phase/2/Examples
5+
- documentation
6+
- board
7+
created: 2024-05-30T11:42:12
8+
---
9+
10+
- [wiring-nodes](https://github.com/ExaDev/breadboard-examples/tree/main/src/examples/wiring-nodes)
11+
[🔗](https://breadboard-ai.web.app/?mode=list&board=https://raw.githubusercontent.com/ExaDev/breadboard-examples/main/src/examples/wiring-nodes/graph.json)

‎content/projects/Breadboard/Phase 2/Examples/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Examples
3+
aliases:
4+
- Breadboard Examples
5+
- Examples
6+
tags:
7+
- breadboard/phase/2
8+
- documentation
9+
- board
10+
created: 2024-05-30T11:42:12
11+
---
12+
13+
## Examples
14+
15+
[github.com/ExaDev/breadboard-examples](https://github.com/ExaDev/breadboard-examples)
16+
17+
### Table of contents
18+
19+
- [Code Nodes](Code%20Nodes)
20+
- [Harness with Diagnostics](Harness%20with%20Diagnostics)
21+
- [Hello World](Hello%20World)
22+
- [Inputs and Outputs](Inputs%20and%20Outputs)
23+
- [Making Kits](Making%20Kits)
24+
- [Running Serialized Board](Running%20Serialized%20Board)
25+
- [Wiring Nodes](Wiring%20Nodes)

‎content/projects/Breadboard/Phase 2/Google Custom Search Engine Tool.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ tags:
77
- cse
88
- google
99
- google_custom_search_engine
10+
- board
1011
created: 2024-06-12T10:50:46
1112
modified: 2024-06-12T11:04:49
1213
---

‎content/projects/Breadboard/Phase 2/Hacker News/Hacker News Algolia Boards.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title:
2+
title:
33
aliases: []
4-
tags: []
4+
tags:
5+
- board
56
created: 2024-06-13T09:21:57
67
modified: 2024-06-14T21:48:05
78
---

‎content/projects/Breadboard/Phase 2/Hacker News/Hacker News Algolia Items.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ aliases: []
44
tags:
55
- breadboard/phase/2
66
- hacker_news
7+
- board
78
created: 2024-06-13T09:21:01
89
modified: 2024-06-13T09:49:19
910
---

‎content/projects/Breadboard/Phase 2/Hacker News/Hacker News Algolia Search.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ aliases: []
44
tags:
55
- breadboard/phase/2
66
- hacker_news
7+
- board
78
created: 2024-06-13T09:19:11
89
modified: 2024-06-14T21:48:07
910
---

‎content/projects/Breadboard/Phase 2/Hacker News/Hacker News Firebase Boards.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title:
33
aliases: []
4-
tags: []
4+
tags:
5+
- board
56
created: 2024-06-13T09:22:10
67
modified: 2024-06-13T09:36:56
78
---

‎content/projects/Breadboard/Phase 2/Hacker News/Hacker News Research Agent.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ aliases: []
44
tags:
55
- breadboard
66
- hacker_news
7+
- board
78
created: 2024-06-14T16:56:00
89
modified: 2024-06-14T17:02:04
910
---

0 commit comments

Comments
 (0)