Skip to content

fix: escape angle brackets in agent notes so the docs build - #433

Merged
sametcelikbicak merged 1 commit into
mainfrom
fix/agents-docs-note-escaping
Oct 6, 2026
Merged

sametcelikbicak merged 1 commit into
mainfrom
fix/agents-docs-note-escaping

Conversation

@sametcelikbicak

Copy link
Copy Markdown
Member

Fixes the Deploy docs failure on main: docs/agents.md:594 aborted the VitePress build with "Element is missing end tag".

scripts/generate-agents-docs.js injected a.notes into markdown unescaped, and several notes carry literal paths — `~/.zcode/skills//SKILL.md`, `/.agents/skills`. VitePress reads a bare `<...>` in a `.md` file as a Vue tag; the unclosed one killed the whole build. The wording was incidental — any future note with an angle bracket would have broken it the same way — so the generator escapes instead.

No CI ran this: `Deploy docs` only builds on push to main, so the failure landed after merge rather than on the PR. A test now asserts the generated Notes section contains no bare <.

@sametcelikbicak
sametcelikbicak merged commit ef2e50f into main Oct 6, 2026
7 checks passed
@sametcelikbicak
sametcelikbicak deleted the fix/agents-docs-note-escaping branch October 6, 2026 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant