Skip to content

Add support for instructions in markdown files with YAML front-matter - #140

Merged
kzu merged 1 commit into
mainfrom
dev/YamlInstructions
Oct 29, 2025
Merged

Add support for instructions in markdown files with YAML front-matter#140
kzu merged 1 commit into
mainfrom
dev/YamlInstructions

Conversation

@kzu

@kzukzu commented Oct 29, 2025

Copy link
Copy Markdown
Member

If instructions are long and the primary content that defines an agent, using TOML is still an inconvenience. For longer text, markdown is king.

We add support for markdown instructions by just relying on YAML front-matter to provide the section data to go along with it.

Example:

---
id: ai.agents.notes
description: Provides free-form memory
client: Grok
options:
modelid: grok-4-fast
---
You organize and keep notes for the user

@kzukzu added the enhancement New feature or request label Oct 29, 2025
If instructions are long and the primary content that defines an agent, using TOML is still an inconvenience. For longer text, markdown is king.
We add support for markdown instructions by just relying on YAML front-matter to provide the section data to go along with it.
Example:
```
---
id: ai.agents.notes
description: Provides free-form memory
client: Grok
options:
modelid: grok-4-fast
---
You organize and keep notes for the user
```
@kzu
kzuforce-pushed the dev/YamlInstructions branch from c6b9acb to 1bff22bCompareOctober 29, 2025 05:16
@kzu
kzu enabled auto-merge (rebase) October 29, 2025 05:16
@kzu

kzu commented Oct 29, 2025

Copy link
Copy Markdown
MemberAuthor

32 passed32 passed18 skipped

🧪 Details on Ubuntu 24.04.3 LTS

from dotnet-retest v1.0.0 on .NET 9.0.10 with 💜 by @devlooped

@kzu
kzu merged commit 8da697a into mainOct 29, 2025
7 checks passed
@kzu
kzu deleted the dev/YamlInstructions branch October 29, 2025 05:18
@devloopeddevlooped locked and limited conversation to collaborators Nov 29, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancementNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@kzu