LAF/Documentation

Документация команды Lazy And Focused — это централизованный источник информации о соглашениях, архитектурах и процессах разработки. Проект построен на основе Nextra и Next.js.

---

📖 О проекте

Данный репозиторий содержит:

• Соглашения по коду и процессам (коммиты, ветки, пул‑реквесты)
• Архитектурные решения (например, FAiL — Frontend Architecture in LAF, или же BAD Архитектура — Backend After Drinking)
• Книги и полезные материалы для команды
• Руководства по работе с проектами

Документация доступна онлайн по адресу: https://docs.laf-team.ru

---

🚀 Быстрый старт

Требования

• Node.js 18.17 или выше
• pnpm (рекомендованный менеджер пакетов)

Установка и запуск

1. Клонируйте репозиторий:

   git clone https://github.com/Lazy-And-Focused/docs.git
   cd docs

2. Установите зависимости:

   pnpm install

3. Запустите сервер разработки:

   pnpm dev

   Документация станет доступна по адресу http://localhost:3000.

Сборка для продакшена

pnpm build
pnpm start

---

🗂 Ключевые директории

• app/ — Next.js App Router (глобальные настройки, layout, страницы)
• content/ — основное содержимое документации (MDX-файлы, _meta.ts)
• public/ — статические файлы (изображения, favicon и т.д.)
• Корневые файлы: package.json, README.md, next.config.ts, tsconfig.json и др.

---

📝 Добавление и редактирование документации

Создание новой страницы

1. Определите, в какую категорию (раздел) попадает страница.
2. Создайте .md или .mdx файл в соответствующей папке.
3. При необходимости укажите frontmatter:

   ---
   title: Заголовок страницы
   sidebarTitle: Название в сайдбаре
   ---

4. Добавьте ссылку на страницу в _meta.ts родительской папки, чтобы изменить её параметры отображения.

Редактирование существующей страницы

• Любые изменения можно вносить прямо в файлы.
• Для тестирования используйте pnpm dev.

Стили и форматирование

• Для форматирования кода используйте стандартные блоки Markdown (` или ``` с указанием языка).
• Придерживайтесь правил, описанных в разделе Соглашения / Документация.

---

🤝 Вклад в проект

Мы приветствуем любой вклад! Если вы хотите исправить ошибку, дополнить информацию или предложить улучшение, следуйте этому процессу:

1. Форкните репозиторий.
2. Создайте ветку с именем, соответствующим соглашению о ветках.
3. Внесите изменения.
4. Оформите коммиты по правилам.
5. Создайте пул‑реквест, указав в описании ссылку на issue (если есть) и описание изменений.

Перед отправкой PR убедитесь, что:

• Документация прошла локальную проверку (pnpm build).
• Все изменения соответствуют общим соглашениям.

---

📄 Лицензия

Весь контент и код в этом репозитории распространяются под лицензией MIT.

---

🙌 Благодарности

• Nextra — за отличную платформу для документации
• Next.js — за мощный React‑фреймворк
• Команда Lazy And Focused — за энтузиазм и вклад в развитие

---

From LAF with love