Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MDSort

Скилл наводит порядок в документации репозитория: инвентаризует markdown, определяет тип каждого документа по содержимому, находит дважды заявленные факты, раскладывает файлы, чинит ссылки во всём дереве — включая код и CI, — собирает индекс из фронтматтера и оставляет валидатор, чтобы порядок не сгнил.

Результат проверяется одним вопросом: незнакомый агент за минуту говорит, что это за проект, какой документ главный, кто выигрывает при противоречии и что делать первым.

In English. A coding-agent skill that sorts a repository's documentation: it classifies every markdown file by what happens when the document and reality disagree, finds facts declared in two places, moves files, rewrites every link across the whole tree (code and CI included), generates the index from front matter, and leaves a POSIX-sh validator behind. The procedure is written in Russian; the tools and the repositories it works on are language-neutral.

Посмотреть, ничего не трогая

sh assets/check-docs.sh     # только читает; работает из корня любого git-репозитория

Пишут на диск только полный /MDSort и --index. --dry-run и --check не меняют ничего.

Установка

Claude Code, во всех проектах:

git clone https://github.com/UltraDeepAutomation/MDSort.git ~/.claude/skills/MDSort

Другой агент — install.sh раскладывает ту же процедуру в его формат и кладёт рядом инструменты, без которых она была бы советом, а не проверяемым результатом:

git clone https://github.com/UltraDeepAutomation/MDSort.git ~/.MDSort
cd /путь/к/проекту && ~/.MDSort/install.sh cursor
Агент Команда Что кладёт
Claude Code, этот проект install.sh claude .claude/skills/MDSort/
Claude Code, все проекты install.sh claude-global ~/.claude/skills/MDSort/
Cursor install.sh cursor .cursor/rules/MDSort.mdc — вызов @MDSort
Windsurf install.sh windsurf .windsurf/rules/MDSort.md
Cline, Roo Code install.sh cline .clinerules/MDSort.md
GitHub Copilot install.sh copilot .github/prompts/MDSort.prompt.md — вызов /MDSort
Codex CLI и всё, что читает AGENTS.md install.sh agents секция в AGENTS.md
Gemini CLI install.sh gemini секция в GEMINI.md
Только CI install.sh tools скрипты в docs/
Любой чат install.sh print процедура в stdout

Дописывания помечены HTML-комментарием: повторный запуск откажется дублировать секцию, а не удвоит её молча.

Устройство

  • SKILL.md — процедура, единственный источник правды для неё
  • reference/kinds.md · templates.md · checks.md — типы, шаблоны, команды и ловушки
  • assets/docs-lib.sh (общий отбор файлов), index-docs.sh, check-docs.sh, move-doc.sh, selftest.sh

sh assets/selftest.sh — 35 утверждений на девяти стендах во временном каталоге. Гоняй после любой правки скриптов.

Настройки

DOCS_INDEX, DOCS_DIR, DOCS_STALE_DAYS, DOCS_OWNS_SIM, DOCS_SITE_ROOT, DOCS_STOPWORDS (слова без владения, через |), DOCS_IGNORE (глобы через :) и файл .mdsortignore в корне репозитория.

Ничего из этого не обязательно: значения по умолчанию рассчитаны на репозиторий, который видит скилл впервые.

Откуда взяты правила

Удаление мёртвого, минимально достаточная документация и «правь документ тем же коммитом, что и код» — Google docguide; четыре режима и запрет их смешивать — Diátaxis; ссылаться вместо пересказа — GitLab SSOT; неизменяемость решений — Azure Well-Architected ADR; ближайший AGENTS.mdagents.md; разделение серьёзности — GitLab Vale; редиректы при переносе — Read the Docs; служебные файлы — GitHub и Keep a Changelog.

Лицензия

MIT

About

Скилл для кодовых агентов: наводит порядок в документации репозитория — классифицирует документы по тому, кто прав при расхождении с реальностью, находит нарушения SSOT, переносит файлы и чинит ссылки во всём дереве, генерирует индекс и оставляет POSIX-sh валидатор для CI

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages