CiWiki є центральним репозиторієм документації та єдиним джерелом правил для всієї екосистеми Cimeika. Всі процеси, стандарти, інструкції та контракти визначаються та підтримуються тут.
| Field | Description |
|---|---|
| Node Role | Documentation, rules, and the canonical source of truth for all Cimeika nodes. |
| Inputs | Change requests (PRs), documentation updates, API traces. |
| Outputs | Canonical instructions, standard contracts/rules, procedural approvals. |
| Dependencies | All other nodes depend on ciwiki for system-wide rules and documentation. |
- ciwiki (цей репозиторій) — Центральна документація та правила
- cit — Основна кодова база проєкту Cimeika
- cimeika-unified — Уніфікована інтеграція компонентів
- citt — Тестування та інтеграційні тести
- media — Медіа ресурси (тільки документація)
- cit_versel — Заморожений репозиторій (без змін)
- COPILOT_CANON.md — Глобальні інструкції для GitHub Copilot
- SECURITY.md — Політика безпеки
- SECURITY_CHECKLIST.md — Security checklist для розробників
- CONTRIBUTING.md — Гайд для контриб'юторів
- CODE_OF_CONDUCT.md — Кодекс поведінки
- LICENSE — MIT License
- CHANGELOG.md — Історія змін
- PR процес — Як створювати та обробляти Pull Request
- Release процес — Процедура випуску релізів
- Тестування — Стандарти тестування
- Управління секретами — Робота з credentials
- Конвенції комітів — Стандарти для commit messages
- Master Issue — Робота з master issues
- Шаблон змін — Обов'язковий шаблон для покрокових змін
- PR Template — Шаблон Pull Request
- Copilot Guard — Захист від витоку секретів
- Repository Status — Статус репозиторію
- Ознайомтесь з COPILOT_CANON.md — основні правила роботи
- Прочитайте PR процес перед створенням PR
- Використовуйте шаблон змін для всіх змін
- Обов'язково: Дотримуйтесь COPILOT_CANON.md
- Перед будь-якою дією перевірте відповідну документацію в
/docs/processes/ - Всі зміни через PR → перевірка → затвердження людиною
- Global rules: ciwiki/.github/copilot-instructions.md
- Canon updated: ciwiki audit history
- All functional changes must pass anti-repeat and intent review.
ciwiki/
├── README.md # Цей файл - головна сторінка
├── COPILOT_CANON.md # Глобальні правила Copilot
├── SECURITY.md # Політика безпеки
├── docs/ # Документація MkDocs
│ ├── processes/ # Процеси та інструкції
│ ├── Cimeika/ # Документація проєкту
│ └── index.md # Головна сторінка документації
├── templates/ # Шаблони для різних процесів
├── policies/ # Політики та правила
├── .github/ # GitHub конфігурація
│ ├── workflows/ # CI/CD workflows
│ └── copilot-instructions.md # Copilot інструкції
└── workflows/ # Додаткові workflow файли
Всі зміни проходять через автоматизовані перевірки:
- Лінтинг коду та документації
- Перевірка безпеки (CodeQL, Secret Scanning)
- Валідація структури документації
- Перевірка MkDocs збірки
Детальніше: CI/CD документація
Документація автоматично публікується на GitHub Pages при кожному push до main:
🌐 Сайт: www.cimeika.com.ua
- MkDocs — генератор статичного сайту
- Material for MkDocs — сучасна тема
- GitHub Actions — автоматичний деплой
# Встановити залежності
pip install mkdocs mkdocs-material
# Запустити dev-сервер
mkdocs serve
# Відкрити http://127.0.0.1:8000- 📖 Налаштування GitHub Pages — швидкий старт
- 📚 Web Publishing процес — повна документація
- 🔧 Детальне налаштування — troubleshooting та перевірка
Ми вітаємо внески від спільноти! 🎉
- Прочитайте CONTRIBUTING.md - повний гайд
- Ознайомтесь з CODE_OF_CONDUCT.md
- Перегляньте Security Checklist
- Створіть feature branch від
main - Зробіть зміни згідно з відповідними process guides
- Переконайтесь що всі тести проходять
- Створіть PR використовуючи template
- Дочекайтесь review та approval
- Merge після затвердження
Важливо: Ніколи не комітьте напряму в main. Всі зміни тільки через PR.
Для питань та проблем:
- Перевірте відповідну документацію в
/docs/processes/ - Створіть issue з детальним описом
- Використовуйте відповідні labels
Last documentation update based on canon: 2026-01-23 — Centralization of Documentation and Processes.