Skip to content

Commit 31dde68

Browse files
committed
Documentation updates
1 parent 37a9a91 commit 31dde68

9 files changed

Lines changed: 32 additions & 31 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44
</a>
55
</p>
66
<h1 align="center">
7-
Plot Agent SDK
7+
Plot Agent Builder
88
</h1>
99
<p align="center">
10-
The official SDK for building <a href="https://plot.day">Plot</a> agents -<br/>
10+
The official package for building <a href="https://plot.day">Plot</a> agents -<br/>
1111
custom code that organizes and prioritizes all your messages, tasks, and apps.
1212
</p>
1313

1414
## Packages
1515

16-
- **[@plotday/agent](./agent)** - Core SDK with types, Agent class, built-in tool interfaces, and CLI
17-
- **[tools/](./tools)** - Tools for building agents, including integrations with popular services
18-
- **[agents/](./agents)** - Full source code for several Plot agents
16+
- **[@plotday/agent](./agent)** - Core agent builder package with the `plot` command, agent and tool SDK, and built-in tools
17+
- **[tools/](./tools)** - Additional tools for building agents, including integrations with popular services
18+
- **[agents/](./agents)** - Full source code for several agents
1919

2020
## Quick Start
2121

@@ -35,11 +35,11 @@ npm run deploy
3535

3636
## Documentation
3737

38-
See the [SDK documentation](./agent/README.md) for detailed guides and API reference.
38+
See the [Plot Agent Builder documentation](https://build.plot.day) for detailed guides and API reference.
3939

4040
## Changelog
4141

42-
See the [SDK changelog](./agent/CHANGELOG.md) for version history and release notes.
42+
See the [builder changelog](./agent/CHANGELOG.md) for version history and release notes.
4343

4444
## License
4545

RELEASING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Releasing Packages
22

3-
This repository uses [Changesets](https://github.com/changesets/changesets) to manage versioning and publishing of packages. This guide explains how to create releases for SDK and tools packages.
3+
This repository uses [Changesets](https://github.com/changesets/changesets) to manage versioning and publishing of packages. This guide explains how to create releases for builder and tools packages.
44

55
## Package Versioning Strategy
66

7-
- **SDK** (`@plotday/agent`): Independent versioning
7+
- **Agent Builder** (`@plotday/agent`): Independent versioning
88
- **Tools** (`@plotday/tool-*`): Independent versioning
99
- **Agents** (`@plotday/agent-*`): Not published, excluded from releases
1010

1111
Each package maintains its own version and can be released independently.
1212

1313
## How to Add a Changeset
1414

15-
When you make changes to the SDK or any tools package, you need to add a changeset before merging your PR.
15+
When you make changes to the builder or any tools package, you need to add a changeset before merging your PR.
1616

1717
### 1. Create a Changeset
1818

@@ -25,7 +25,7 @@ This will prompt you with:
2525
1. **Which packages would you like to include?**
2626

2727
- Select the packages you've modified (use space to select, enter to confirm)
28-
- Only SDK and tools packages can be selected (agents are excluded)
28+
- Only builder and tools packages can be selected (agents are excluded)
2929

3030
2. **What kind of change is this?**
3131

@@ -53,14 +53,14 @@ The changeset file will be created in `.changeset/` with a random name like `.ch
5353

5454
1. **Developer makes changes**
5555

56-
- Make your changes to SDK or tools packages
56+
- Make your changes to builder or tools packages
5757
- Run `pnpm changeset` to add a changeset
5858
- Commit the changeset file along with your changes
5959
- Open a PR to `main`
6060

6161
2. **PR validation**
6262

63-
- GitHub Actions will check if SDK/tools were modified
63+
- GitHub Actions will check if builder/tools were modified
6464
- If modified, it ensures a changeset file exists
6565
- PR cannot be merged without a changeset (or admin override)
6666

@@ -79,7 +79,7 @@ The changeset file will be created in `.changeset/` with a random name like `.ch
7979
- Builds all packages
8080
- Publishes changed packages to npm
8181
- Creates GitHub releases with changelogs
82-
- Tags each release (e.g., `sdk@0.9.1`, `tool-google-calendar@0.1.0`)
82+
- Tags each release (e.g., `agent@0.9.1`, `tool-google-calendar@0.1.0`)
8383

8484
## GitHub Releases
8585

@@ -89,7 +89,7 @@ When packages are published, GitHub releases are automatically created with the
8989

9090
Each package gets its own tag based on its directory structure:
9191

92-
- **SDK**: `sdk@0.9.1`
92+
- **Agent Builder**: `agent@0.9.1`
9393
- **Tools**: `tool-google-calendar@0.1.0`, `tool-outlook-calendar@0.1.0`, etc.
9494

9595
This tagging convention allows you to:
@@ -112,16 +112,16 @@ View all releases at: `https://github.com/plotday/plot/releases`
112112

113113
Or filter by package:
114114

115-
- SDK releases: Search for tags starting with `sdk@`
115+
- Builder releases: Search for tags starting with `agent@`
116116
- Tool releases: Search for tags starting with `tool-`
117117

118118
### Manual GitHub Release
119119

120120
If you need to create a GitHub release manually after publishing:
121121

122122
```bash
123-
# For SDK
124-
gh release create sdk@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release notes here"
123+
# For Agent Builder
124+
gh release create agent@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release notes here"
125125

126126
# For a tool
127127
gh release create tool-google-calendar@0.1.0 --title "@plotday/tool-google-calendar@0.1.0" --notes "Release notes here"
@@ -198,7 +198,7 @@ git push
198198
pnpm release
199199

200200
# 5. (Optional) Create GitHub release manually
201-
gh release create sdk@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release notes"
201+
gh release create agent@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release notes"
202202
```
203203

204204
⚠️ This should only be done in emergencies. The automated workflow is preferred.
@@ -240,4 +240,4 @@ gh release create sdk@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release note
240240

241241
- [Changesets documentation](https://github.com/changesets/changesets)
242242
- [Semantic Versioning (semver)](https://semver.org/)
243-
- [Plot SDK repository](https://github.com/plotday/plot)
243+
- [Plot repository](https://github.com/plotday/plot)

builder/DOCS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains the TypeDoc-generated API documentation for the Plot Age
44

55
## Published Documentation
66

7-
The SDK documentation is automatically published to GitHub Pages whenever changes are pushed to the main branch:
7+
The Agent Builder documentation is automatically published to GitHub Pages whenever changes are pushed to the main branch:
88

99
**Live Documentation**: [https://plotday.github.io/plot/](https://plotday.github.io/plot/)
1010

@@ -79,7 +79,7 @@ When changes to the Builder are pushed to the main branch, a GitHub Action autom
7979
- Builds the Builder and generates the documentation
8080
- Deploys it to GitHub Pages at [https://plotday.github.io/plot/](https://plotday.github.io/plot/)
8181

82-
**Workflow Location**: `.github/workflows/deploy-sdk-docs.yml`
82+
**Workflow Location**: `.github/workflows/deploy-docs.yml`
8383

8484
**Trigger**: Automatic on push to `main` when files in `public/agent/**` change
8585

@@ -99,13 +99,13 @@ If you need to enable or configure GitHub Pages for this repository:
9999
2. Under "Source", select: **GitHub Actions**
100100
3. The workflow will automatically handle deployment
101101

102-
The `deploy-sdk-docs.yml` workflow includes all necessary permissions and configurations for GitHub Pages deployment.
102+
The `deploy-docs.yml` workflow includes all necessary permissions and configurations for GitHub Pages deployment.
103103

104104
## Configuration
105105

106106
The documentation generation is configured in `typedoc.json`. Key settings:
107107

108-
- **Entry Points**: Main SDK exports (agent, tool, plot, tools/\*)
108+
- **Entry Points**: Main Agent Builder exports (agent, tool, plot, tools/\*)
109109
- **Output**: `dist/docs/`
110110
- **Visibility**: Public APIs only (excludes private/protected/internal members)
111111
- **Theme**: Default TypeDoc theme optimized for GitHub Pages

builder/cli/commands/create.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ export async function createCommand(options: CreateOptions) {
8585
const sdkPackage = JSON.parse(fs.readFileSync(sdkPackagePath, "utf-8"));
8686
sdkVersion = `^${sdkPackage.version}`;
8787
} catch (error) {
88-
console.warn("Warning: Could not read SDK version, using fallback");
88+
console.warn(
89+
"Warning: Could not read Agent Builder version, using fallback"
90+
);
8991
}
9092

9193
// Generate a unique agent ID

builder/cli/commands/generate.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ export async function generateCommand(options: GenerateOptions) {
312312

313313
// Update @plotday/agent to latest and install packages
314314
try {
315-
out.progress("Updating SDK to latest version...");
315+
out.progress("Updating Agent Builder to latest version...");
316316

317317
const updateCommand =
318318
packageManager === "npm"

builder/cli/utils/output.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,7 @@ export function blank() {
121121
*/
122122
export function cliHeader(version: string) {
123123
const title = "Plot";
124-
const subtitle = `SDK v${version}`;
125-
// const title = `Plot SDK ${colors.dim(`v${version}`)}`;
124+
const subtitle = `Agent Builder v${version}`;
126125
const underline = colors.brand(
127126
"─".repeat(title.length + subtitle.length + 1)
128127
);

builder/docs/BUILDING_TOOLS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Build custom tools when you need to:
3737
| ------------------------------ | ------------------------------------ |
3838
| Plot, Store, AI, Network, etc. | Your integrations and utilities |
3939
| Access to Plot internals | Built on top of built-in tools |
40-
| Provided by SDK | Created by you or installed from npm |
40+
| Provided by Agent Builder | Created by you or installed from npm |
4141
| Always available | Declared as dependencies |
4242

4343
---

builder/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://json.schemastore.org/tsconfig",
3-
"display": "Plot SDK",
3+
"display": "Plot Agent Builder",
44
"compilerOptions": {
55
"target": "ESNext",
66
"lib": ["ES2021", "ES2022.error", "WebWorker"],

builder/typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"docs/RUNTIME.md",
4343
"docs/ADVANCED.md"
4444
],
45-
"name": "Build Plot Agents",
45+
"name": "Plot Agent Builder",
4646
"includeVersion": false,
4747
"disableSources": false,
4848
"sourceLinkTemplate": "https://github.com/plotday/plot/blob/main/builder/{path}#L{line}",

0 commit comments

Comments
 (0)