Skip to content

About

Технічні рекомендації від менторів GoIT

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TechTips hub

Сховище технічних рекомендацій ментора для курсів GoIT. Кожна сторінка — це рекомендації для одного курсу, з окремим посиланням. Загального списку сторінок немає.

Адреса сторінки: https://techtips.goit.global/<курс>-<суфікс>/, наприклад .../python-core-eef613/. Випадковий суфікс не дає вгадати адресу іншої сторінки.

Усі сторінки мають один дизайн. Він лежить у спільному шаблоні. Сторінка курсу містить тільки текст: модулі, поради, типові помилки, посилання.

Як працювати зі сторінками

Відкрийте Claude Code у цьому репозиторії і напишіть, що потрібно. Правила для Claude записані в CLAUDE.md.

Додати сторінку:

Зроби технічні рекомендації для курсу Python Developer. Ось програма курсу і мої нотатки: (вставте текст або файл)

Claude створить сторінку і відкриє її в браузері для перегляду. Якщо все добре, напишіть «публікуй». Claude опублікує сторінку і дасть посилання. Сторінка відкривається через 1–2 хвилини.

Дизайн описувати не потрібно: кольори, шрифт і вигляд карток бере шаблон. Потрібен тільки зміст:

  1. Модулі курсу. Якщо курс поділено на блоки, то блоки і модулі в них.
  2. Поради до кожного модуля.
  3. Типові помилки студентів, якщо вони є.
  4. Корисні посилання, якщо вони є.
  5. Питання для самоперевірки, якщо вони потрібні.

Якщо ви даєте готовий текст, Claude не змінює слова, а тільки розкладає текст за структурою. Якщо ви просите Claude написати поради, Claude запитає про те, чого не знає.

Змінити сторінку:

Зміни рекомендації курсу Python Core: у модулі 3 додай пораду про модуль zoneinfo.

Посилання не змінюється.

Прибрати сторінку:

Видали рекомендації курсу Python Core.

Після публікації посилання дає помилку 404.

Що є на сторінці

  • Вкладки блоків. Якщо курс має блоки, кожен блок відкривається окремою вкладкою. Посилання на блок: …/#b2, на модуль у блоці: …/#b2-m3.
  • Пошук. Поле «Пошук порад» угорі шукає в усіх модулях і блоках. Клавіша Esc скидає пошук.
  • Позначки в порадах: «Чому так», «Як правильно», «Приклад», «Лайфхак», «Увага», «Типова помилка», «Примітка». Під заголовком сторінки є легенда.
  • Чек-лист самоперевірки. Відповідь схована під кнопкою «Відповідь». Галочки зберігаються в браузері студента, окремо для кожної сторінки.
  • Кнопка «Копіювати» на блоках коду і шаблонах.

Важливо

  • Репозиторій публічний. Не додавайте на сторінки персональні дані та внутрішню інформацію.
  • Сторінку захищає тільки складне посилання. Хто має посилання, той відкриє сторінку.
  • Стара версія сторінки залишається в історії git, навіть після видалення.
  • Зміна шаблону змінює всі сторінки одразу.
  • Адреси сторінок залежать від домену techtips.goit.global. Не змінюйте домен і не видаляйте його DNS-запис: усі видані посилання перестануть працювати.

Як це влаштовано

Шлях Що це
site/_shared/recs.css, site/_shared/recs.js Спільний шаблон: дизайн, вкладки, пошук, чек-лист, перевірка даних
site/<курс>-<суфікс>/index.html Одна сторінка: тільки дані курсу
scripts/new-recs.sh Створює папку для нової сторінки з випадковим суфіксом
scripts/check.sh Перевіряє сторінки перед публікацією
scripts/validate-recs.js Перевіряє дані курсу (використовує check.sh)
.github/workflows/deploy.yml Після кожного push у main запускає перевірку і публікує site/ на GitHub Pages

Що перевіряє scripts/check.sh:

  1. У корені site/ є тільки папки сторінок і шаблон _shared.
  2. Назва папки має формат <курс>-<6 символів>, і в папці є тільки index.html.
  3. Сторінка підключає шаблон і не має власних стилів, скриптів чи localStorage.
  4. Сторінка має <meta name="robots" content="noindex, nofollow">, щоб пошукові системи її не індексували.
  5. Дані курсу не мають помилок: немає пропущених обов'язкових полів, невідомих полів і недозволених тегів.
  6. Сторінки не посилаються одна на одну.

Якщо перевірка не проходить, публікація не відбувається. Помилку видно у вкладці Actions на GitHub.

About

Технічні рекомендації від менторів GoIT

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages