Перейти к основному содержимому

Полное покрытие кода

Эта страница объясняет, что именно покрыто документацией и где искать описание каждого участка проекта.

Уровни покрытия

Документация покрывает проект на трёх уровнях:

УровеньЧто покрываетГде читать
АрхитектурныйПотоки запросов, providers, routes, границы, внешние зависимостиАрхитектура, Backend и API
ДоменныйКаталог, roadmap, proxy pages, banners, admin, данныеДомены, Frontend и админка, Reference
ReferenceВсе основные папки, классы, resources, views, configs, migrations, helpersСправочная база

Карта покрытия по корневым папкам

ПутьПокрытиеОсновной раздел
bootstrap/*ПолностьюBootstrap и провайдеры
routes/*ПолностьюRoutes и middleware, Jobs/cron
config/*Полностью по назначениюConfig/env reference, Конфигурация и безопасность
app/Actions/*Полностью по назначениюAuth, actions, services reference
app/Casts/*Полностью по назначениюHelpers, casts, traits reference
app/Console/*ПолностьюCommands reference, Jobs/cron
app/Domains/*Полностью по доменным зонамDomains reference, Каталог, Roadmap, Proxy pages
app/Facades/*ПолностьюAuth, actions, services reference
app/Filament/*Полностью списком и группамиFilament reference, Filament-админка
app/Helpers/*Полностью по функциям/назначениюHelpers, casts, traits reference
app/Http/*ПолностьюRoutes и middleware, Backend reference
app/Jobs/*ПолностьюJobs, очереди и cron
app/Livewire/*ПолностьюLivewire reference, Livewire и partial SPA
app/Models/*Полностью по группам и ключевым инвариантамModels reference, Models and domain
app/Observers/*ПолностьюModels reference
app/Policies/*ПолностьюConfig/security, Models reference
app/Providers/*ПолностьюBootstrap и провайдеры
app/Services/*ПолностьюAuth, actions, services reference
app/Settings/*ПолностьюConfig/env reference, Migrations and datamodel
app/Socialite/*ПолностьюAuth, actions, services reference
app/Traits/*ПолностьюHelpers, casts, traits reference
app/Types/*ПолностьюHelpers, casts, traits reference
app/View/*ПолностьюViews/assets reference, Proxy pages
database/*Полностью по группамDatabase reference, Migrations and datamodel
resources/*Полностью по группамViews/assets reference, Frontend overview
apps/docs/*Полностью по работе с документациейКак работать с этой документацией

Что считается “100% покрытием” здесь

В этой документации “100% покрытие” означает:

  • каждый production-каталог проекта имеет описание назначения;
  • каждая группа классов имеет объяснение роли;
  • каждый важный поток имеет пошаговое описание;
  • каждый Filament resource перечислен;
  • каждая модельная группа перечислена;
  • все helpers/casts/traits/types перечислены;
  • все config-файлы перечислены;
  • все migration/data слои объяснены;
  • все views/assets группы перечислены;
  • известные риски и side effects вынесены отдельно.

Это не построчный комментарий к каждой строке кода. Построчный комментарий был бы вреден: он быстро устареет и станет дублировать код. Вместо этого документация фиксирует назначение, владельца поведения, входы/выходы, side effects и сценарии изменения.

File-level coverage matrices

Полное пофайловое покрытие разнесено по матрицам:

В этих страницах перечислены все production-значимые файлы из app, database, resources, config, routes и bootstrap.

Где читать по задаче

ЗадачаСтраница
Найти любой файлКарта файлов проекта, Полный индекс файлов
Понять модельModels reference
Понять админскую страницуFilament reference
Понять Livewire componentLivewire reference
Понять helper/trait/castHelpers, casts, traits reference
Понять Blade/view/assetsViews/assets reference
Понять env/configConfig/env reference
Понять миграцию/таблицыDatabase reference, Миграции и модель данных
Добавить продуктHow-to: работа с данными
Добавить roadmap программуHow-to: работа с данными
Добавить proxy pageHow-to: работа с данными
Починить page cacheПоддержка и эксплуатация