NPPWEB Docs

Репозиторий документации организации nppweb.

Здесь собран единый docs-сайт по всей экосистеме проекта:

• архитектуре платформы;
• локальному запуску и deploy-сценариям;
• parser lifecycle и source adapters;
• ownership репозиториев;
• аналитическому контуру и интерпретации метрик;
• эксплуатационной диагностике и runbook-сценариям.

Что это за сайт

Документация в .github задумана как единая точка входа в проект:

• для новых разработчиков;
• для аналитиков, которым нужно понимать происхождение данных;
• для администраторов, которые поддерживают runtime и deploy;
• для команды, которая меняет сразу несколько репозиториев и хочет держать целостную картину.

Основные разделы

• Обзор — что такое NPPWEB и как устроена система в целом
• Быстрый старт — как поднять платформу локально
• Архитектура — поток данных и границы сервисов
• Аналитика — как читать экраны и метрики
• Репозитории — ownership и ответственность каждого сервиса
• Эксплуатация — GitHub Pages, диагностика и runbook

Локальный запуск docs

npm install
npm run docs:dev

Production build

npm run docs:build

Что особенно важно в текущей версии

• документация покрывает не только витринный обзор, но и реальные эксплуатационные сценарии;
• появился отдельный runbook по диагностике проблем с данными и пайплайном;
• углублены страницы по всем основным репозиториям;
• сильнее разделены technical, operational и business-смыслы данных;
• docs можно использовать как онбординг по всей платформе, а не только как справочник по VitePress.

Deploy

Публикация на GitHub Pages настроена через workflow deploy-docs.yml.