diff --git a/CONTRIBUTING.ru.md b/CONTRIBUTING.ru.md new file mode 100644 index 0000000..842718f --- /dev/null +++ b/CONTRIBUTING.ru.md @@ -0,0 +1,168 @@ +# Вклад в проект «Агентная инженерия для людей» + +Прежде всего — спасибо, что вы здесь. Это руководство существует благодаря людям, которые делятся своим опытом. Каждый вклад делает этот ресурс лучше для следующего человека, который пытается разобраться в работе с ИИ-агентами. + +## Коротко о главном + +1. **Мелкие исправления** (опечатки, сломанные ссылки, уточнения) — Просто отправьте PR +2. **Новый контент или крупные изменения** — Сначала откройте Issue, чтобы обсудить +3. **Не уверены?** — Спросите в [Discord](https://kilo.love/discord) или создайте обсуждение + +## Что мы ищем + +### Ценные вклады + +- **Опыт из практики** — Что реально сработало (или нет), когда вы это пробовали +- **Практические примеры** — Фрагменты кода, промпты, рабочие процессы, которые можно использовать +- **Обновлённая информация** — Область развивается быстро; помогите не отставать +- **Новые перспективы** — Разные инструменты, языки, размеры команд, отрасли +- **Более ясные объяснения** — Если вас смутило что-то, это, вероятно, смущает и других + +### Контент, который мы, скорее всего, не примем + +- **Маркетинговые материалы** — Никаких рекламных постов под видом руководств +- **Непроверенные утверждения** — «Продуктивность выросла в 10 раз» нуждаются в подтверждении +- **Сгенерированный ИИ контент** — Иронично, да, но мы ценим человеческое видение +- **Дублирующий контент** — Убедитесь, что мы уже не освещаем это где-то + +## Как внести вклад + +### Изменения в документации + +1. Сделайте форк репозитория +2. Создайте ветку (`git checkout -b fix/opечатка-в-начале-работы`) +3. Внесите изменения +4. Запустите `bun dev` для локального предпросмотра +5. Зафиксируйте с понятным сообщением +6. Отправьте PR + +### Новые страницы или разделы + +1. **Сначала откройте Issue** — Опишите, что вы хотите добавить и почему +2. Дождитесь обратной связи (обычно в течение нескольких дней) +3. После утверждения следуйте шагам выше + +### Стиль написания + +Соблюдайте существующий тон: + +- **Прямолинейный и практичный** — Переходите к делу +- **Обращение на «ты»** — «Ты», а не «разработчик» +- **Короткие абзацы** — Максимум 3–5 предложений +- **Реальные примеры** — Показывайте, а не просто рассказывайте +- **Без лишнего** — Каждое предложение должно быть на своём месте + +Смотрите существующие страницы как примеры. При сомнениях читайте [Начало работы](/engineers/getting-started/) — это тот стиль, который мы используем. + +### Структура файлов + +``` +src/content/docs/ +├── introduction/ # Основные концепции +├── engineers/ # Контент для индивидуальных участников +├── team-leads/ # Контент по управлению командой +├── executives/ # Стратегический контент +├── use-cases/ # Пошаговые руководства +├── governance/ # Риски и соответствие требованиям +├── appendices/ # Справочные материалы +└── community/ # Участие, информация о сообществе +``` + +### Фронтматтер + +Каждая страница должна содержать фронтматтер: + +```yaml +--- +title: Заголовок страницы +description: Описание в одном предложении для SEO и превью +sidebar: + order: 1 # Позиция в боковой панели (необязательно) +--- +``` + +## Трекинг задач + +Мы используем [GitHub Issues](https://github.com/Kilo-Org/agentic-path/issues) для отслеживания работы. Прежде чем начать: + +1. **Проверьте существующие Issues** — Возможно, кто-то уже работает над этим +2. **Откройте Issue для крупных изменений** — Давайте обсудим, прежде чем вы потратите время +3. **Закомментируйте Issue, если вы берёте его в работу** — Чтобы другие знали + +Смотрите [открытые Issues](https://github.com/Kilo-Org/agentic-path/issues) — можно найти что-то интересное, или создайте новое, если заметили пробел. + +## Процесс отправки Pull Request + +1. **Ограничьтесь одним логическим изменением в одном PR** +2. **Напишите понятное описание** — Что изменилось и почему +3. **Ссылайтесь на связанные Issues** — Используйте «Fixes #123» или «Relates to #456» +4. **Будьте терпеливы** — Мы рецензируем в течение недели, обычно быстрее + +### Что мы проверяем + +- Соответствует ли ваш вариант стилю и тону? +- Информация точная? +- Добавляет ли ценность для читателей? +- Проходит ли сборка? + +## Локальная разработка + +```bash +# Клонируйте свой форк +git clone https://github.com/YOUR-USERNAME/agentic-path.git +cd agentic-path + +# Установите зависимости +bun install + +# Запустите сервер для разработки +bun dev + +# Соберите, чтобы проверить на ошибки +bun build +``` + +Сайт по умолчанию запускается на `http://localhost:4321`. + +## Принципы взаимодействия в сообществе + +### Уважайте друг друга + +- Предполагайте добрые намерения +- Конструктивное несогласие приветствуется +- Личные нападки недопустимы +- Помогайте новичкам чувствовать себя уютно + +### При рецензировании работы других + +- Будьте конструктивными, а не критикующими +- Предлагайте улучшения, а не просто указывайте на проблемы +- Помните, что с другой стороны тоже человек + +### Получая обратную связь + +- Не воспринимайте всерьёз +- Задавайте уточняющие вопросы при необходимости +- Не соглашаться — нормально, можно обсудить + +## Признание участников + +Участники признаются несколькими способами: + +- История Git (ваши коммиты остаются навсегда) +- Страница контрибьюторов на GitHub +- Упоминания в заметках о релизе за значительный вклад + +## Вопросы? + +- **Быстрые вопросы** — [Discord](https://kilo.love/discord) +- **Более развёрнутые обсуждения** — [GitHub Discussions](https://github.com/Kilo-Org/agentic-path/discussions) +- **Отчёты о багах** — [GitHub Issues](https://github.com/Kilo-Org/agentic-path/issues) + +## Лицензия + +Внося вклад в проект, вы соглашаетесь, что ваш материал распространяется под лицензией MIT. + +--- + +Спасибо снова за участие. Каждое улучшение помогает кому-то работать с ИИ-агентами эффективнее. Это очень круто. diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..5a705a9 --- /dev/null +++ b/README.ru.md @@ -0,0 +1,89 @@ +# Агентная инженерия для людей + +Практические руководства и ресурсы для понимания того, как работает программная инженерия и управление командой в пост-ИИ мире. + +🌐 **Онлайн-версия:** [path.kilo.ai](https://path.kilo.ai) + +## Что это такое? + +Это исчерпывающее руководство по агентной инженерии — практике эффективной работы с ИИ-агентами по программированию. Независимо от того, являетесь ли вы инженером, который осваивает эффективное взаимодействие с ИИ, тимлидом, внедряющим агентов в рабочие процессы, или руководителем, строящим стратегию внедрения — здесь найдётся подходящий путь для вас. + +**Это общественный проект.** Мы создаём его вместе, потому что область развивается быстро, и ни один взгляд не может охватить всё. Ваш опыт важен — независимо от того, пользуетесь ли вы ИИ-инструментами много лет или только начали на прошлой неделе. + +## Содержание + +- **Введение** — Что такое агентная инженерия, как работают агенты и возникающие тенденции +- **Для инженеров** — Начало работы, декомпозиция задач и лучшие практики +- **Для тимлидов** — Внедрение инструментов, измерение эффекта и обеспечение качества +- **Для руководителей** — Стратегическое видение, фреймворки ROI и соответствие требованиям безопасности +- **Прецеденты использования** — Планирование, реализация, развёртывание и документирование +- **Управление и риски** — Проверка безопасности, ответственность и контроль качества +- **Приложения** — Глоссарий, рекомендуемая литература и шаблоны запросов + +## Технологический стек + +Создано на [Astro](https://astro.build) и [Starlight](https://starlight.astro.build), стилизация — [Catppuccin](https://github.com/catppuccin/starlight). + +## Разработка + +```bash +# Установка зависимостей +bun install + +# Запуск локального сервера +bun dev + +# Сборка для продакшна +bun build + +# Предпросмотр продакшен-сборки +bun preview +``` + +## Как внести вклад + +Мы с радостью примем вашу помощь по улучшению этого ресурса. Есть много способов внести вклад: + +### Быстрые вклады + +- **Нашли опечатку или сломанную ссылку?** Отправьте PR напрямую — отдельный запрос не нужен +- **Есть ресурс, который стоит поделиться?** Добавьте его в соответствующий раздел «Ресурсы» +- **Заметили устаревшую информацию?** Сообщите нам или исправьте сами + +### Более крупные вклады + +- **Новый контент** — Знаете область, которую мы не затронули? Мы хотим это видеть +- **Практические примеры** — Кейсы, истории реального опыта и выводы бесценны +- **Переводы** — Помогите сделать этот ресурс доступным для большего числа людей +- **Улучшение инструментов** — Лучший поиск, навигация или доступность + +### Как внести вклад + +1. **Проверьте открытые Issues** — Возможно, кто-то уже работает над этим +2. **Сначала создайте Issue** для крупных изменений — давайте обсудим, прежде чем вы потратите время +3. **Сделайте форк и отправьте PR** — Стандартный GitHub-поток +4. **Делайте акцент на практичность** — Мы ценим реальный опыт выше теории + +Детальные рекомендации смотрите в [CONTRIBUTING.ru.md](CONTRIBUTING.ru.md). + +## Сообщество + +Это не просто документация — это разговор. Присоединяйтесь: + +- **[Discord](https://kilo.love/discord)** — Задавайте вопросы, делитесь успехами, обсуждайте рабочие решения +- **[GitHub Discussions](https://github.com/Kilo-Org/agentic-path/discussions)** — Более развернутые обсуждения и предложения +- **[GitHub Issues](https://github.com/Kilo-Org/agentic-path/issues)** — Отчёты о багах и запросы функционала + +### Кодекс поведения + +Уважайте друг друга. Мы все вместе осваиваем новую область. Конструктивное несогласие приветствуется; личные нападки — нет. + +## Лицензия + +[Apache 2.0](LICENSE) — Используйте, расширяйте, делитесь. + +## Ссылки + +- [Discord](https://kilo.love/discord) +- [GitHub](https://github.com/Kilo-Org/agentic-path) +- [Kilo Code](https://kilo.ai) — Команда за этим руководством diff --git a/astro.config.mjs b/astro.config.mjs index 8439519..9bbac73 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -4,11 +4,243 @@ import starlight from "@astrojs/starlight"; import catppuccin from "@catppuccin/starlight"; import sitemap from "@astrojs/sitemap"; -// https://astro.build/config +const enSidebar = [ + { + label: "Introduction", + items: [ + { + label: "What is Agentic Engineering?", + slug: "introduction/what-is-agentic-engineering", + }, + { + label: "How Agents Work", + slug: "introduction/how-agents-work", + }, + { + label: "Working with Agents", + slug: "introduction/working-with-agents", + }, + { + label: "Trends & Patterns", + slug: "introduction/trends-patterns", + }, + ], + }, + { + label: "For Engineers", + items: [ + { label: "Getting Started", slug: "engineers/getting-started" }, + { + label: "Task Decomposition", + slug: "engineers/task-decomposition", + }, + { label: "Best Practices", slug: "engineers/best-practices" }, + ], + }, + { + label: "For Team Leads", + items: [ + { + label: "Adopting Agentic Tools", + slug: "team-leads/adopting-agentic-tools", + }, + { + label: "Measuring Impact", + slug: "team-leads/measuring-impact", + }, + { + label: "Quality Assurance", + slug: "team-leads/quality-assurance", + }, + { + label: "The 1-Pizza Team", + slug: "team-leads/1-pizza-teams", + }, + ], + }, + { + label: "For Executives", + items: [ + { label: "Strategic Vision", slug: "executives/strategic-vision" }, + { label: "ROI Frameworks", slug: "executives/roi-frameworks" }, + { + label: "Adoption Playbook", + slug: "executives/adoption-playbook", + }, + { + label: "Security & Compliance", + slug: "executives/security-compliance", + }, + { + label: "AI-Native Economics", + slug: "executives/ai-native-economics", + }, + ], + }, + { + label: "Use Cases by Phase", + items: [ + { + label: "Planning & Design", + slug: "use-cases/planning-design", + }, + { label: "Implementation", slug: "use-cases/implementation" }, + { + label: "Deployment & Operations", + slug: "use-cases/deployment-operations", + }, + { + label: "Quality & Documentation", + slug: "use-cases/quality-documentation", + }, + ], + }, + { + label: "Governance & Risk", + items: [ + { label: "Security Review", slug: "governance/security-review" }, + { label: "Accountability", slug: "governance/accountability" }, + { label: "Quality Gates", slug: "governance/quality-gates" }, + ], + }, + { + label: "Appendices", + items: [ + { label: "Glossary", slug: "appendices/glossary" }, + { label: "Recommended Reading", slug: "appendices/reading-list" }, + { label: "Prompt Templates", slug: "appendices/prompt-templates" }, + ], + }, + { + label: "Community", + items: [ + { label: "Join the Community", slug: "community" }, + { label: "Contributing", slug: "community/contributing" }, + ], + }, +]; + +const ruSidebar = [ + { + label: "Введение", + items: [ + { + label: "Что такое агентная инженерия?", + slug: "introduction/what-is-agentic-engineering", + }, + { + label: "Как работают агенты", + slug: "introduction/how-agents-work", + }, + { + label: "Работа с агентами", + slug: "introduction/working-with-agents", + }, + { + label: "Тенденции и закономерности", + slug: "introduction/trends-patterns", + }, + ], + }, + { + label: "Для инженеров", + items: [ + { label: "Начало работы", slug: "engineers/getting-started" }, + { + label: "Декомпозиция задач", + slug: "engineers/task-decomposition", + }, + { label: "Лучшие практики", slug: "engineers/best-practices" }, + ], + }, + { + label: "Для тимлидов", + items: [ + { + label: "Внедрение агентных инструментов", + slug: "team-leads/adopting-agentic-tools", + }, + { + label: "Измерение влияния", + slug: "team-leads/measuring-impact", + }, + { + label: "Обеспечение качества", + slug: "team-leads/quality-assurance", + }, + { + label: "Команда из одной пиццы", + slug: "team-leads/1-pizza-teams", + }, + ], + }, + { + label: "Для руководителей", + items: [ + { label: "Стратегическая visión", slug: "executives/strategic-vision" }, + { label: "Фреймворки ROI", slug: "executives/roi-frameworks" }, + { + label: "Плейбук внедрения", + slug: "executives/adoption-playbook", + }, + { + label: "Безопасность и соблюдение норм", + slug: "executives/security-compliance", + }, + { + label: "Искусственный интеллект в нативной экономике", + slug: "executives/ai-native-economics", + }, + ], + }, + { + label: "Прецеденты использования по этапам", + items: [ + { + label: "Планирование и дизайн", + slug: "use-cases/planning-design", + }, + { label: "Реализация", slug: "use-cases/implementation" }, + { + label: "Развертывание и эксплуатация", + slug: "use-cases/deployment-operations", + }, + { + label: "Качество и документация", + slug: "use-cases/quality-documentation", + }, + ], + }, + { + label: "Управление и риски", + items: [ + { label: "Проверка безопасности", slug: "governance/security-review" }, + { label: "Ответственность", slug: "governance/accountability" }, + { label: "Качество контрольных точек", slug: "governance/quality-gates" }, + ], + }, + { + label: "Приложения", + items: [ + { label: "Глоссарий", slug: "appendices/glossary" }, + { label: "Рекомендуемая литература", slug: "appendices/reading-list" }, + { label: "Шаблоны запросов", slug: "appendices/prompt-templates" }, + ], + }, + { + label: "Сообщество", + items: [ + { label: "Присоединиться к сообществу", slug: "community" }, + { label: "Вклад в проект", slug: "community/contributing" }, + ], + }, +]; + export default defineConfig({ site: "https://path.kilo.ai", integrations: [ starlight({ + title: "Agentic Engineering", head: [ { tag: "script", @@ -18,10 +250,6 @@ export default defineConfig({ }, }, ], - title: "Agentic Engineering", - editLink: { - baseUrl: "https://github.com/Kilo-Org/agentic-path/edit/main/", - }, components: { Footer: "./src/components/Footer.astro", Header: "./src/components/Header.astro", @@ -38,121 +266,6 @@ export default defineConfig({ href: "https://github.com/Kilo-Org/agentic-path", }, ], - sidebar: [ - { - label: "Introduction", - items: [ - { - label: "What is Agentic Engineering?", - slug: "introduction/what-is-agentic-engineering", - }, - { - label: "How Agents Work", - slug: "introduction/how-agents-work", - }, - { - label: "Working with Agents", - slug: "introduction/working-with-agents", - }, - { - label: "Trends & Patterns", - slug: "introduction/trends-patterns", - }, - ], - }, - { - label: "For Engineers", - items: [ - { label: "Getting Started", slug: "engineers/getting-started" }, - { - label: "Task Decomposition", - slug: "engineers/task-decomposition", - }, - { label: "Best Practices", slug: "engineers/best-practices" }, - ], - }, - { - label: "For Team Leads", - items: [ - { - label: "Adopting Agentic Tools", - slug: "team-leads/adopting-agentic-tools", - }, - { - label: "Measuring Impact", - slug: "team-leads/measuring-impact", - }, - { - label: "Quality Assurance", - slug: "team-leads/quality-assurance", - }, - { - label: "The 1-Pizza Team", - slug: "team-leads/1-pizza-teams", - }, - ], - }, - { - label: "For Executives", - items: [ - { label: "Strategic Vision", slug: "executives/strategic-vision" }, - { label: "ROI Frameworks", slug: "executives/roi-frameworks" }, - { - label: "Adoption Playbook", - slug: "executives/adoption-playbook", - }, - { - label: "Security & Compliance", - slug: "executives/security-compliance", - }, - { - label: "AI-Native Economics", - slug: "executives/ai-native-economics", - }, - ], - }, - { - label: "Use Cases by Phase", - items: [ - { - label: "Planning & Design", - slug: "use-cases/planning-design", - }, - { label: "Implementation", slug: "use-cases/implementation" }, - { - label: "Deployment & Operations", - slug: "use-cases/deployment-operations", - }, - { - label: "Quality & Documentation", - slug: "use-cases/quality-documentation", - }, - ], - }, - { - label: "Governance & Risk", - items: [ - { label: "Security Review", slug: "governance/security-review" }, - { label: "Accountability", slug: "governance/accountability" }, - { label: "Quality Gates", slug: "governance/quality-gates" }, - ], - }, - { - label: "Appendices", - items: [ - { label: "Glossary", slug: "appendices/glossary" }, - { label: "Recommended Reading", slug: "appendices/reading-list" }, - { label: "Prompt Templates", slug: "appendices/prompt-templates" }, - ], - }, - { - label: "Community", - items: [ - { label: "Join the Community", slug: "community" }, - { label: "Contributing", slug: "community/contributing" }, - ], - }, - ], customCss: ["./src/styles/custom.css"], plugins: [ catppuccin({ @@ -160,7 +273,25 @@ export default defineConfig({ light: { flavor: "latte", accent: "peach" }, }), ], + locales: { + en: { + label: "English", + title: "Agentic Engineering", + editLink: { + baseUrl: "https://github.com/Kilo-Org/agentic-path/edit/main/", + }, + sidebar: enSidebar, + }, + ru: { + label: "Русский", + title: "Агентная инженерия", + editLink: { + baseUrl: "https://github.com/Kilo-Org/agentic-path/edit/main/ru/", + }, + sidebar: ruSidebar, + }, + }, }), sitemap(), ], -}); +}); \ No newline at end of file diff --git a/src/components/ContributeBanner.astro b/src/components/ContributeBanner.astro index 41431af..038b20f 100644 --- a/src/components/ContributeBanner.astro +++ b/src/components/ContributeBanner.astro @@ -4,14 +4,14 @@ ---
- - + +