Changelog

Все значимые изменения в документации фиксируются на этой странице.

2026-04-30

Added

  • Добавлен полноценный раздел UX-портфолио под резюме UX Writer / Product Writer.
  • Добавлены UX-кейсы: онбординг нового пользователя, аудит формы и чеклист UX-текста.
  • Главная страница обновлена под двойное позиционирование: Technical Writer / DocOps / UX Writer.

Changed

  • Раздел UX-писательство переработан в витрину UX-кейсов с описанием процесса работы.
  • Страница Обо мне и контакты обновлена под две версии профиля: technical documentation и UX writing.

2026-04-29

Changed

  • В контактном блоке ссылка на закрытое резюме на HH заменена на публичный профиль LinkedIn.
  • Внутренние ссылки обновлены под текущий адрес сайта: /portfolio/.
  • Ссылка на GitHub-репозиторий обновлена после переименования проекта в portfolio.

2026-04-28

Added

  • Для страницы Changelog добавлен front matter с ShowToc: false, чтобы убрать шумный TOC в боковой панели.

Changed

  • Обновлена палитра портала: базовый фон сменен на #1c1e20 для более мягкого тёмного тона.
  • Главная страница адаптирована под Hugo/PaperMod: заменен MkDocs-синтаксис кнопок на HTML-кнопки (cta-btn), исправлены ссылки карточек.
  • Переписаны кастомные стили под PaperMod, убраны конфликтующие правила .md-* от MkDocs.
  • Для контейнера .main снято принудительное растягивание (min-height), чтобы не создавать пустое пространство на коротких страницах.

Fixed

  • Исправлена читаемость Interactive API: повышен контраст текста и элементов в Swagger UI на тёмной теме.
  • Дополнительно исправлена читаемость блока Schemas (модели, свойства, скобки и разделители).
  • Убран фон у pre-блоков (.post-content pre) для более чистого отображения кода.

2026-04-19

Added

  • Добавлена страница Interactive API со Swagger UI на базе openapi/openapi.yaml.
  • Миграция портала на тему Material for MkDocs.
  • Добавлены разделы портала: Бизнес-аналитика, Разработчикам, Пользователям, О проекте.
  • Добавлены страницы с контентом: BPMN, C4, UML, onboarding, troubleshooting, дашборд продаж.
  • Добавлены исходники диаграмм PlantUML (docs/diagrams/*.puml) и скрипт рендера scripts/render-diagrams.sh.
  • Добавлена страница Docs as Code с описанием подхода.

Changed

  • Репозиторий и сайт переведены на новое имя: petstore-api-docs (обновлен site_url).
  • Усилен Quick Start: добавлен пример на JavaScript (fetch) и блок проверки типовых ошибок (400, 404).
  • Обновлена навигация портала с многоуровневой структурой.
  • CI workflow обновлен: установка зависимостей из requirements.txt, рендер PlantUML-диаграмм и сборка портала перед деплоем.
  • Добавлены критерии качества и измеримые показатели на главной странице.
  • Добавлены разделы обратной связи на ключевые страницы портала.
  • Добавлен README.md для быстрого ревью кейса рекрутером/лидом.
  • Добавлен финальный QA Checklist в документацию.
  • В CI добавлена валидация OpenAPI спецификации перед рендером и деплоем.
  • Улучшен UX портала: обновлены тема/палитра, вкладки навигации, breadcrumbs и интегрированный TOC.
  • Главная страница переработана в формат карточек разделов для быстрого сканирования.
  • Удалены страницы-заглушки из структуры документации.

Fixed

  • Локализация пагинации (Previous/Next) стабилизирована с учетом динамической перерисовки темы.
  • Исправлен CSS-отступ заголовков (margin-bottom: 10px) через docs/stylesheets/extra.css.
  • Исправлена загрузка OpenAPI в Interactive API (fallback путей, устранен 404).
  • Исправлены несовместимые диаграммы xychart-beta в сценариях (замена на совместимый формат).

QA

  • Release check passed: проверены ключевые страницы latest/ и root (/), включая Interactive API, сценарии, версии и changelog.

2026-04-11

Added

  • Добавлен раздел Changelog в структуру документации.
  • Добавлена страница истории изменений для портфолио-кейса.
  • Добавлена страница Версии API с политикой версионирования и шаблоном для v3.
  • Добавлен плагин поиска search в конфигурацию MkDocs.
  • Добавлен кастомный CSS docs/stylesheets/extra.css для управления отступами заголовков.

Changed

  • Обновлена структура API Reference: endpoints сгруппированы по ресурсам (Pet, Store).
  • В API Reference добавлен раздел про поиск и фильтрацию в документации.
  • В Getting Started исправлена разметка списков для корректного отображения по строкам.

Fixed

  • Исправлена локализация пагинации (Previous/Next) в теме Read the Docs.
  • Улучшен JS-хук локализации, чтобы перевод применялся после динамической перерисовки DOM.
  • Удалены лишние блоки с общими best practices с главной страницы.

2026-04-10

Changed

  • Проект переведен с плейсхолдерного TaskFlow API на публичный Swagger Petstore API.
  • Обновлены Home, Getting Started, API Reference и openapi/openapi.yaml под реальные публичные эндпоинты.

Added

  • Добавлены русские подписи пунктов меню в навигации документации.

2026-04-09

Added

  • Подготовлена базовая структура контента для API-документации: Home, Getting Started, API Reference.
  • Добавлены примеры запросов и ответы для быстрого старта.

Fixed

  • Исправлен CI-деплой GitHub Pages: добавлено разрешение contents: write в workflow.