Skip to content

Commit 2200542

Browse files
authored
Merge pull request #8 from elizaOS/fix/cli-icons-font-awesome
fix: update CLI reference icons to valid Font Awesome names
2 parents 280b09e + 56af68a commit 2200542

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

cli-reference/create.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create Command
33
description: Initialize a new project, plugin, or agent with an interactive setup process
4-
icon: plus-circle
4+
icon: circle-plus
55
---
66

77
# Create Command

cli-reference/monorepo.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Monorepo Command
33
description: Clone the ElizaOS monorepo for development or contribution
4-
icon: git-branch
4+
icon: code-branch
55
---
66

77
# Monorepo Command

cli-reference/publish.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Publish Command
33
description: Publish a plugin to npm, create a GitHub repository, and submit to the ElizaOS registry
4-
icon: cloud-upload
4+
icon: cloud-arrow-up
55
---
66

77
# Publish Command

cli-reference/update.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Update Command
33
description: Update your project's ElizaOS dependencies and CLI to the latest published versions
4-
icon: rotate
4+
icon: arrows-rotate
55
---
66

77
# Update Command

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@
212212
"groups": [
213213
{
214214
"group": "Getting Started",
215-
"pages": ["plugins"]
215+
"pages": ["plugins/overview"]
216216
},
217217
{
218218
"group": "Core Plugins",

guides/plugin-migration/completion-requirements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Final Setup"
33
description: "Essential steps to complete before committing and publishing your plugin"
4-
icon: "check-circle"
4+
icon: "circle-check"
55
---
66

77
This document outlines the essential steps to complete before committing and publishing the plugin. Please follow each step carefully to ensure proper configuration.

guides/plugin-migration/migration-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Basic Migration Steps"
33
description: "General framework for migrating ElizaOS plugins to v1.x"
4-
icon: "list-check"
4+
icon: "clipboard-list"
55
---
66

77
> **Important**: This guide provides a general framework for migrating ElizaOS plugins to v1.x. Specific configurations will vary based on your plugin's functionality.

guides/plugin-migration/prompt-and-generation-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Prompts & Generation"
33
description: "Migrating from `composeContext` to new prompt composition methods and `useModel`"
4-
icon: "sparkles"
4+
icon: "wand-magic-sparkles"
55
---
66

77
> **Important**: This guide provides comprehensive documentation for migrating from `composeContext` to the new prompt composition methods, and from the old generation functions to `useModel`.

guides/plugin-publishing-guide.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,23 +74,23 @@ import { Plugin, IAgentRuntime } from "@elizaos/core";
7474
export const myAwesomePlugin: Plugin = {
7575
name: "my-awesome-plugin",
7676
description: "A plugin that does awesome things",
77-
77+
7878
actions: [
7979
// Your custom actions
8080
],
81-
81+
8282
providers: [
8383
// Your custom providers
8484
],
85-
85+
8686
evaluators: [
8787
// Your custom evaluators
8888
],
89-
89+
9090
services: [
9191
// Your custom services
9292
],
93-
93+
9494
async init(runtime: IAgentRuntime) {
9595
// Initialize your plugin
9696
console.log("My Awesome Plugin initialized!");
@@ -108,12 +108,12 @@ import { Action, IAgentRuntime, Memory, HandlerCallback } from "@elizaos/core";
108108
const greetAction: Action = {
109109
name: "GREET_USER",
110110
description: "Greets the user with a personalized message",
111-
111+
112112
validate: async (runtime: IAgentRuntime, message: Memory) => {
113113
// Validate the action can be performed
114114
return message.content.text.toLowerCase().includes("hello");
115115
},
116-
116+
117117
handler: async (
118118
runtime: IAgentRuntime,
119119
message: Memory,
@@ -128,7 +128,7 @@ const greetAction: Action = {
128128
action: "GREET_USER"
129129
});
130130
},
131-
131+
132132
examples: [
133133
[
134134
{
@@ -137,7 +137,7 @@ const greetAction: Action = {
137137
},
138138
{
139139
user: "assistant",
140-
content: {
140+
content: {
141141
text: "Hello! Welcome to Eliza!",
142142
action: "GREET_USER"
143143
}
@@ -466,4 +466,4 @@ If you run into issues:
466466
3. Ask in Discord #plugin-dev channel
467467
4. Open an issue on your plugin's repo
468468

469-
Remember: Publishing a plugin is just the beginning. The best plugins evolve based on user feedback and community contributions!
469+
Remember: Publishing a plugin is just the beginning. The best plugins evolve based on user feedback and community contributions!

plugins.mdx renamed to plugins/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Plugin System Overview"
2+
title: "Overview"
33
description: "Comprehensive guide to the ElizaOS plugin system architecture and implementation"
44
---
55

0 commit comments

Comments
 (0)