Этот репозиторий — источник документации, которую личный кабинет ПД отображает в собственном интерфейсе. Содержимое хранится как переносимый Markdown-bundle и не требует Sphinx или GitHub Pages.
manifest.jsonзадаёт заголовок, разделы, порядок страниц и стабильные URL-slug.pages/содержит страницы в формате GitHub Flavored Markdown.faq/содержит ответы на частые вопросы, сгруппированные по разделам изmanifest.json.assets/предназначен только для локальных raster-изображений документации.scripts/validate.mjsпроверяет контракт bundle перед публикацией.
Имена slug, файлов и расширений используют строчные латинские буквы, цифры и дефисы. В Markdown разрешены обычные и внутренние ссылки, но не raw HTML, внешние изображения, symlink или пути за пределами bundle. Локальные изображения хранятся в assets/; разрешены расширения .png, .jpg, .jpeg, .gif, .webp и .avif только в нижнем регистре. SVG не допускается как активный same-origin контент.
Блок faq в manifest.json задаёт общий заголовок и упорядоченный список разделов с slug, title и путём file. Для каждого раздела используется отдельный файл faq/*.md.
Каждый вопрос начинается заголовком второго уровня ##, а ответ продолжается до следующего такого заголовка:
## Как сдать проект?
Ответ может содержать **Markdown**, списки, безопасные ссылки и код.Заголовок первого уровня запрещён. Вопрос и ответ не могут быть пустыми; заголовки ### и ниже допустимы внутри ответа. Валидатор также запрещает raw HTML, небезопасные ссылки, внешние изображения, symlink и FAQ-файлы, не перечисленные в manifest.
-
Создайте ветку от
main. -
Измените Markdown и при необходимости
manifest.json. -
Выполните:
npm test npm run validate -
Откройте pull request и после проверки объедините его в
main.
После merge администратор приложения публикует точный коммит:
./deploy.sh docs <full-commit-sha>Приложение хранит каждый опубликованный commit как неизменяемый релиз. Повторная публикация предыдущего SHA выполняет откат без пересборки приложения.