Skip to content

Glossary: one term per file, pure Markdown - #12

Merged
prikotov-agent[bot] merged 5 commits into
masterfrom
task/glossary-pure-md-anchors
Sep 22, 2026
Merged

prikotov-agent[bot] merged 5 commits into
masterfrom
task/glossary-pure-md-anchors

Conversation

@prikotov-agent

@prikotov-agent prikotov-agent Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Задача

TASK-fix-glossary-pure-md-anchors

Постановка

Глоссарий использовал 26 явных HTML-якорей <a id="...">: валидатор prikotov/coding-standard их не распознаёт (индексирует только заголовки) и ложно помечает ссылки на термины как битые. Владельцем принята политика чистого Markdown, а из вариантов исполнения выбран файл на термин: автославки двуязычных заголовков (#выкладка-deployment-deploy) отвергнуты как нечитаемые, а переименование файла — в отличие от переименования заголовка — прозрачно отслеживается git'ом.

Что сделано

  • docs/git-workflow/glossary/ — 26 файлов терминов (repository.md … production.md): front matter пакета, H1 с полным двуязычным названием, определение. Старый glossary.md удалён.
  • glossary/index.md — обзорный словарь: 4 секции, списки ссылок на термины; пример файловой ссылки в преамбуле.
  • Ссылки на термины стали файловыми: release.md → glossary/release-publishing.md; внутренние ссылки терминов — ../pull-request.md, ../release.md#…, deployment.md; обновлены оглавление index.md, README.md, AGENTS.md.
  • Итог: [выкладка](glossary/deployment.md) — чистый Markdown, читается в исходнике и в URL, ASCII-путь, стабилен к переформулировкам.

Проверки

  • validate-md-links (prikotov/coding-standard v0.33.0) на docs/git-workflow/ — все ссылки валидны.
  • grep "<a id=" docs/ → пусто.
  • composer validate --strict — valid (CI пакета).

Breaking changes

Меняются URL терминов (было glossary.md#deployment/glossary.md#выпуск-release-publishing, стало glossary/deployment.md и т.д.) — все ссылки внутри пакета обновлены; внешние глубокие ссылки на глоссарий, если есть, стоит поправить.

…менить HTML-якоря чистым Markdown
@prikotov-agent prikotov-agent Bot added the pi Pi Coding Agent label Sep 22, 2026
@prikotov-agent prikotov-agent Bot changed the title Glossary: replace HTML anchors with pure Markdown headings Glossary: one term per file, pure Markdown Sep 22, 2026
@prikotov-agent
prikotov-agent Bot merged commit 322db83 into master Sep 22, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pi Pi Coding Agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant