Skip to content

dev #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Gokujo merged 8 commits into from
Jul 25, 2025
Merged

dev #9

Gokujo merged 8 commits into from
Jul 25, 2025

Conversation

@Gokujo
Copy link
Collaborator

@Gokujo Gokujo commented Jul 25, 2025

  • Добавлена подробная и структурированная документация для моделей, исключений API и ReviewResponse с примерами использования и рекомендациями по обработке ошибок
  • Удалена устаревшая документация для NotKinopoisk PHP Wrapper и других неактуальных файлов
  • Добавлены метаданные для улучшения SEO и структурирования документации
  • Обновлены и исправлены ссылки, форматирование, стили и навигация в документации
  • Добавлен CI/CD workflow для проверки безопасности кода, обновления зависимостей, сборки и деплоя документации, а также генерации changelog
  • Обновлены зависимости и добавлены новые плагины mkdocs для улучшения сборки и функционала документации

Maxim Harder added 8 commits July 25, 2025 09:40
@gitbutler-client
📝 DOCS Добавляет документацию для моделей и исключений API
f277dd8 
- Добавлена подробная документация для исключения InvalidApiKeyException  
  с описанием, примерами использования, обработкой и рекомендациями  
- Создана новая страница с обзором моделей данных Kinopoisk API  
  с навигацией по категориям моделей, связанным сервисам и перечислениям  
- Включены примеры создания и работы с моделями Film, Person, Staff  
- Обновлены рекомендации по обработке ошибок и валидации API ключа  
- Документация структурирована для удобства использования и быстрого старта
@gitbutler-client
🔧 chore: добавить CI/CD workflow для проекта
64bfef4 
- Добавлен workflow для проверки безопасности кода с Bandit и Safety
- Добавлен workflow для автоматического обновления зависимостей по расписанию
- Добавлен workflow для сборки и деплоя документации на Git Pages
- Добавлен workflow для генерации changelog при выпуске новых тегов
- Настроены автоматические комментарии с результатами проверки безопасности в PR
@gitbutler-client
♻️ UPDATE Удаляю устаревшую документацию NotKinopoisk PHP Wrapper
f0fc30e 
- Полностью удалена старая документация из docs/dev/notkinopoiskphp/README.md
- Удаление связано с обновлением структуры проекта или переносом документации
- Обновлен requirements.txt с добавлением новых плагинов mkdocs для улучшения сборки документации
- Добавлены mkdocs-awesome-pages-plugin и mkdocs-section-index для расширения функционала документации
@gitbutler-client
📝 DOCS Обновляет документацию для ReviewResponse и навигации
b1e6cbd 
- Добавляет подробное описание класса ReviewResponse с примерами использования
- Описывает структуру, методы, свойства и обработку ошибок ReviewResponse
- Обновляет ссылки в документации исключений и моделей для корректной навигации
- Исправляет и улучшает карту навигации в документации
- Обновляет зависимости для генерации документации (mkdocs)
@gitbutler-client
♻️ UPDATE Исправляет форматирование и структуру документации
0d4d493 
- Добавляет навигационные файлы для новых разделов документации
- Исправляет ссылки и форматирование в markdown файлах
- Обновляет стили CSS для корректного отображения статусов
- Оптимизирует отступы и выравнивание в шаблонах и стилях
- Добавляет скрипт установки зависимостей с принудительной переустановкой
@gitbutler-client
📝 DOCS Удаляю устаревшую документацию
a0a206e 
- Удалены файлы docs/dev/crowdin.md и docs/dev/releasestatus.md
- Очистка репозитория от неактуальной документации для упрощения поддержки
@gitbutler-client
📝 DOCS Добавляет метаданные и описания в документацию
14c87dd 
- Добавлены frontmatter блоки с тегами, описаниями, ключевыми словами и
  авторами для улучшения SEO и структурирования документации
- Обновлены файлы документации по моделям, сервисам, исключениям и плагинам
- Исправлены опечатки и улучшена читаемость в инструкциях и описаниях
- Обновлены ссылки и изображения для корректного отображения в соцсетях и
  предпросмотре страниц
@gitbutler-client
♻️ UPDATE конфигурации и workflow для сборки и безопасности
11c12af 
- Обновлен mkdocs.yml: исправлен плагин tags для корректной работы
- Изменена команда сборки документации в deploy.yml с --strict на -c для
  оптимизации процесса
- Обновлен action upload-artifact в security.yml с версии v3 на v4 для
  улучшения стабильности загрузки артефактов
@github-actions
Copy link
Contributor

github-actions bot commented Jul 25, 2025

🔒 Security Check Results

🚨 Bandit Security Issues

Run started:2025-07-25 17:33:27.055627

Test results:
	No issues identified.

Code scanned:
	Total lines of code: 0
	Total lines skipped (#nosec): 0
	Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
	Total issues (by severity):
		Undefined: 0
		Low: 0
		Medium: 0
		High: 0
	Total issues (by confidence):
		Undefined: 0
		Low: 0
		Medium: 0
		High: 0
Files skipped (0):

This report was generated automatically by GitHub Actions

@Gokujo Gokujo merged commit a2a7f74 into main Jul 25, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Gokujo