Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added docs for payroll-agent #164

Closed
wants to merge 1 commit into from
Closed

added docs for payroll-agent #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions community/templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,12 @@
"description": "A template for a Cointoss bot.",
"icon": "🪙",
"author": "humanagent"
},
{
"href": "/templates/payroll-agent",
"title": "Payroll Agent",
"description": "An autonomous payroll management agent that handles employee registration, payments, and scheduling",
"icon": "💰",
"author": "raihankhan-rk"
}
]
72 changes: 72 additions & 0 deletions packages/docs/pages/templates/payroll-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Payroll Agent

An autonomous payroll management agent that handles employee registration, payments, and scheduling.

## Structure

```
payroll-agent/
├── src/
│ ├── plugins/
│ │ ├── payroll.ts
│ │ └── redis.ts
│ ├── skills/
│ │ ├── register.ts
│ │ ├── remove.ts
│ │ └── list.ts
│ ├── vibes/
│ │ └── degen.ts
│ └── index.ts
├── package.json
├── tsconfig.json
└── .env
```

## Agent

The process that starts listening to messages and replying to them.

```tsx [src/index.ts]
// [!include ~/../../templates/payroll-agent/src/index.ts]
```

## Skills

- [Register](/skills/register): Register new employees with payment details
- [Remove](/skills/remove): Remove employees from the payroll system
- [List](/skills/list): List all registered employees and their payment details
- [Concierge](/skills/concierge): Agent Wallet as a Service
Comment on lines +35 to +38
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Missing documentation files for 'remove' and 'list' skills

The verification revealed that only 2 out of 4 referenced skill documentation files exist:

  • ✓ /skills/register.mdx
  • ✗ /skills/remove.mdx (missing)
  • ✗ /skills/list.mdx (missing)
  • ✓ /skills/concierge.mdx
🔗 Analysis chain

Verify skill documentation links.

The skills section references documentation pages that may not exist yet. Please ensure these links are valid:

  • /skills/register
  • /skills/remove
  • /skills/list
  • /skills/concierge
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the skill documentation files exist
for skill in register remove list concierge; do
  fd -t f "${skill}\.(mdx|md)" packages/docs/pages/skills
done

Length of output: 491


## Plugins

- [Payroll](/plugins/payroll): Handles automated payroll processing and scheduling
- [Redis](/plugins/redis): Persistent storage for employee data

## Vibes

- [Degen](/vibes/degen): High-energy crypto trader personality

## Variables

Set up these variables in your app:

```bash [cmd]
// [!include ~/../../templates/payroll-agent/.env.example]
```

## End result

The end result is a prompt that the model can understand and use to respond to the user.

```md [example_prompt.md]
// [!include ~/../../templates/payroll-agent/example_prompt.md]
```

## Features

- 🔄 Automated monthly payroll processing
- 👥 Employee management (add/remove/list)
- 💰 Automatically release payouts in USDC to employees
- 📅 Configurable payment dates
- 💾 Persistent storage with Redis
- 🤖 Crypto-native personality
Loading