Skip to content

Commit c9104ef

Browse files
jasperfjasperf
authored
Merge pull request #2 from imagewize/patch/documentation
Patch/documentation
2 parents 13e9304 + 36b4921 commit c9104ef

2 files changed

Lines changed: 113 additions & 81 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.0.1] - 2025-06-25
11+
12+
### Changed
13+
14+
**README.md - Repository Rebranding:**
15+
- Rebranded from WordPress/Imagewize-specific to general-purpose agent library
16+
- Added origin story clarifying Imagewize roots while emphasizing adaptability
17+
- Updated title from "mistral-agents" to "Mistral Agents"
18+
19+
**README.md - Structure & Content:**
20+
- **Added**: Quick Start section with step-by-step setup instructions
21+
- **Removed**: Configuration section (redundant with Quick Start)
22+
- **Renamed**: "Imagewize Projects" → "WordPress Context (Optional)" to make it optional reading
23+
- **Renamed**: "Adding New Agent Prompts" → "Adding Your Own Agents" with enhanced guidance
24+
- **Renamed**: "Critical Rules (All Agents)" → "Universal Critical Rules" for broader applicability
25+
- **Restructured**: Available Agents as a clear table with role, focus, and audience columns
26+
- **Restructured**: WordPress project table simplified (removed Target Audience column)
27+
- **Updated**: Contributing section to explicitly welcome non-WordPress contributions
28+
- **Updated**: Resources section - removed internal theme directory links
29+
- **Updated**: Planned Agents from checklist format to list format
30+
- **Updated**: Footer from "Maintained by Imagewize for internal" to "Originally created by Imagewize; now maintained for the Mistral Le Chat community"
31+
1032
## [1.0.0] - 2025-04-11
1133

1234
### Added

‎README.md‎

Lines changed: 91 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,126 +1,136 @@
1-
# mistral-agents
1+
# Mistral Agents
22

3-
Mistral Le Chat Agent Prompts for Imagewize Development
3+
**A library of specialized Mistral Le Chat agent prompts for developers, designers, and creators.**
44

5-
## Overview
5+
This repository provides production-ready agent system prompts that you can load directly into [Mistral Le Chat](https://chat.mistral.ai) to get consistent, high-quality output for specific roles and workflows.
66

7-
This repository contains **specialized agent prompts** for Mistral Le Chat, configured for use across Imagewize projects. It serves as a centralized library of role-specific instructions that guide Le Chat agents when working on different types of tasks.
7+
Imagewize originally created this for WordPress theme development (Elayne, Nynaeve), but the prompts are designed to be **adaptable to any project**. Use as-is, extend, or fork to fit your needs.
88

9-
## Repository Structure
9+
---
10+
11+
## ✨ Quick Start
12+
13+
1. Copy any `.md` file (e.g., `FRONTEND-DEV.md`)
14+
2. Paste into Le Chat → **Agents** → New Agent → **System Prompt**
15+
3. Set model to `mistral-large-latest` or `devstral`
16+
4. Start chatting!
17+
18+
> **Tip**: All prompts follow a consistent structure - you can easily modify them for your tech stack.
19+
20+
---
21+
22+
## 📂 Repository Structure
1023

1124
```
1225
mistral-agents/
1326
├── .vibe/
14-
│ ├── config.toml # Vibe CLI configuration (optional, for local dev)
27+
│ ├── config.toml # Optional Vibe CLI config
1528
│ └── prompts/
16-
│ └── vibe.md # Repository-level prompt context
17-
├── README.md # This file
18-
├── FRONTEND-DEV.md # Frontend Developer Agent
19-
└── (future agent prompts)
29+
│ └── vibe.md # Repository context
30+
├── README.md
31+
├── FRONTEND-DEV.md # Frontend Developer (WordPress-focused)
32+
├── BACKEND-DEV.md # Backend Developer (planned)
33+
└── (add your own!)
2034
```
2135

22-
## Available Agents
36+
---
37+
38+
## 🎯 Available Agents
39+
40+
| Agent | Role | Focus | Best For |
41+
|-------|------|-------|----------|
42+
| [FRONTEND-DEV.md](/FRONTEND-DEV.md) | Senior Frontend Developer | WordPress themes, HTML/CSS, block patterns | WordPress devs, theme authors |
43+
44+
**Planned Agents:**
45+
- `BACKEND-DEV.md` - PHP/WordPress & general backend development
46+
- `DEVOPS.md` - Deployment, infrastructure, and CI/CD
47+
- `CONTENT-STRATEGY.md` - Content planning and SEO
48+
- `UI-UX.md` - User interface and experience design
49+
- `QA-TESTING.md` - Quality assurance and testing strategies
50+
- `ACCESSIBILITY.md` - WCAG compliance and a11y best practices
51+
52+
> **Note on WordPress Agents**: The current `FRONTEND-DEV.md` is tailored for Imagewize's Elayne (FSE block theme) and Nynaeve (Sage 11 hybrid theme). See [WordPress Context](#-wordpress-context) below for details.
2353
24-
### 📱 [FRONTEND-DEV.md](/FRONTEND-DEV.md)
25-
**Role**: Senior Frontend Developer
26-
**Scope**: WordPress theme development (HTML/CSS components, page templates, block patterns)
27-
**Projects**: imagewize.com, Nynaeve, Elayne
28-
**Output**: Production-ready code with developer handoff notes
54+
---
55+
56+
## 🌐 WordPress Context (Optional)
2957

30-
*See [FRONTEND-DEV.md](/FRONTEND-DEV.md) for full specifications.*
58+
*For users of the WordPress-specific agents:*
3159

32-
## Imagewize Projects
60+
This repository originated to support these Imagewize projects:
3361

34-
This repository supports development across three main projects:
62+
| Project | Type | Tech Stack |
63+
|---------|------|------------|
64+
| **Elayne** | FSE Block Theme | Gutenberg, theme.json, patterns |
65+
| **Nynaeve** | Sage 11 Hybrid | Blade, ACF Composer, React blocks |
66+
| **imagewize.com** | Site | Enterprise WordPress |
3567

36-
| Project | Type | Target Audience | Tech Stack |
37-
|---------|------|-----------------|------------|
38-
| **imagewize.com** | Company/Blog Site | Marketing | WordPress |
39-
| **Nynaeve** | Theme | Premium Clients | Sage 11, Blade, ACF Composer, React |
40-
| **Elayne** | Theme | End Users | FSE, Gutenberg Blocks, theme.json |
68+
**The WordPress agents include:**
69+
- Full page builds with component extraction
70+
- Developer handoff notes with WP implementation mappings
71+
- Project-specific conventions (FSE block compatibility, ACF fields, etc.)
4172

42-
## Adding New Agent Prompts
73+
*You can ignore this section if you're using the agents for non-WordPress work.*
74+
75+
---
4376

44-
When adding a new agent to this repository:
77+
## 📝 Adding Your Own Agents
4578

46-
1. **Create a new markdown file** in the root directory
47-
2. **Use role-based naming**: `ROLE-DEV.md`, `ROLE-SPECIALIST.md`, etc.
48-
3. **Include the following sections**:
79+
1. **Create**: New `.md` file in root (e.g., `BACKEND-DEV.md`)
80+
2. **Name it well**: Use role-based naming like `ROLE-SPECIALIZATION.md`
81+
3. **Structure your prompt**:
4982
- Role description and scope
5083
- Critical rules (do's and don'ts)
5184
- Output format expectations
52-
- Project-specific constraints
53-
- Handoff notes requirements
54-
4. **Update this README** with the new agent in the Available Agents section
55-
5. **Reference in vibe.md** for Vibe CLI context
56-
57-
### Agent Naming Convention
85+
- Examples of expected output
86+
- Project-agnostic instructions where possible
5887

88+
**Naming Convention:**
5989
```
60-
{ROLE}-{SPECIALIZATION}.md e.g., BACKEND-WORDPRESS.md
90+
{ROLE}-{SPECIALIZATION}.md e.g., BACKEND-PHP.md
6191
{ROLE}.md e.g., DEVOPS.md
6292
{TEAM}-{ROLE}.md e.g., FRONTEND-DEV.md
6393
```
6494

65-
## Usage
95+
**Quality Checklist:**
96+
- [ ] Clear, specific instructions (no "you should probably")
97+
- [ ] Examples of expected output
98+
- [ ] Do's and don'ts explicitly stated
99+
- [ ] Project-agnostic where possible (add variants for specific stacks)
100+
- [ ] Follows existing formatting in other prompts
101+
102+
---
103+
104+
## 🏗 Universal Critical Rules
66105

67-
### With Mistral Le Chat
106+
*Applied across all agents in this repository:*
68107

69-
1. Go to [Le Chat](https://chat.mistral.ai) and open **Agents**
70-
2. Create a new agent or edit an existing one
71-
3. Copy the contents of the relevant `.md` file (e.g. `FRONTEND-DEV.md`) into the **System prompt** field
72-
4. Set the model (recommended: `mistral-large-latest` or `devstral`)
73-
5. Save and start chatting
108+
1. **Production-ready output only** - No placeholders, descriptions, or "replace with X" comments
109+
2. **Mobile-first** - All output must be responsive by default
110+
3. **No centered overlay heroes** - This is the most common failure pattern to avoid
111+
4. **Realistic content** - Use relevant dummy content, never lorem ipsum or placeholder text
112+
5. **Consistent formatting** - Follow the repository's style guidelines
74113

75-
## Planned Agents
114+
---
76115

77-
- [ ] **BACKEND-DEV.md** - PHP/WordPress backend development
78-
- [ ] **DEVOPS.md** - Deployment, infrastructure, and CI/CD
79-
- [ ] **CONTENT-STRATEGY.md** - Content planning and SEO
80-
- [ ] **UI-UX.md** - User interface and experience design
81-
- [ ] **QA-TESTING.md** - Quality assurance and testing strategies
82-
- [ ] **ACCESSIBILITY.md** - WCAG compliance and a11y best practices
116+
## 🔗 Resources
83117

84-
## Configuration
118+
- [Mistral Le Chat](https://chat.mistral.ai)
119+
- [Mistral Agent Documentation](https://docs.mistral.ai/capabilities/agent/)
120+
- [Imagewize](https://imagewize.com) - Original creators of this repository
85121

86-
The `.vibe/config.toml` file is kept for optional local Vibe CLI use. See `.vibe/prompts/vibe.md` for repository-level context documentation.
122+
---
87123

88-
## Contributing
124+
## 🤝 Contributing
89125

90126
1. Fork this repository
91127
2. Create a new branch for your agent prompt
92128
3. Add your `.md` file following the naming convention
93129
4. Update the README with your agent's details
94130
5. Submit a pull request
95131

96-
### Quality Guidelines
97-
98-
- ✅ **Be specific**: Clear, unambiguous instructions
99-
- ✅ **Be actionable**: Tell the agent WHAT to do and HOW
100-
- ✅ **Include examples**: Show expected output formats
101-
- ✅ **Document constraints**: List what NOT to do
102-
- ✅ **Project-aware**: Tailor to Imagewize conventions
103-
- ❌ **Avoid vagueness**: No "you should probably..."
104-
- ❌ **Avoid placeholders**: No lorem ipsum or TODOs in agent outputs
105-
106-
## Critical Rules (All Agents)
107-
108-
These rules apply across all agent prompts in this repository:
109-
110-
1. **Production-ready output only** - No placeholders, descriptions, or "replace with X" comments
111-
2. **Mobile-first** - All output must be responsive
112-
3. **No centered overlay heroes** - This is the most common failure mode
113-
4. **Realistic content** - Use relevant dummy content, never lorem ipsum
114-
5. **Project-specific conventions** - Honor each project's tech stack and aesthetic
115-
116-
## Resources
117-
118-
- [Mistral Le Chat](https://chat.mistral.ai)
119-
- [Mistral Le Chat Agents Docs](https://docs.mistral.ai/capabilities/agent/)
120-
- [Imagewize](https://imagewize.com)
121-
- [Elayne Theme](~/code/imagewize.com/demo/web/app/themes/elayne/)
122-
- [Nynaeve Theme](~/code/imagewize.com/demo/web/app/themes/nynaeve/)
132+
We welcome contributions for any domain - not just WordPress!
123133

124134
---
125135

126-
*Maintained by Imagewize for internal development workflows.*
136+
*Originally created by Imagewize; now maintained for the Mistral Le Chat community.*

0 commit comments

Comments
 (0)