Base do manual e atualização
Este manual foi elaborado a partir dos códigos de belle-front-v1 e belle-api-v1 disponíveis em 30/10/2026. A descrição prioriza telas, permissões, validações e estados implementados. Planejamentos de produto não foram tratados como prova de disponibilidade.
Fontes por assunto
Os caminhos abaixo são relativos aos dois repositórios locais. Eles servem para a equipe de manutenção conferir mudanças de comportamento.
| Assunto | Front (belle-front-v1) | Back (belle-api-v1) |
|---|---|---|
| Navegação e visibilidade | src/app/shared/shell/nav-menu.model.ts, src/app/app-routing.module.ts | src/utils/permissions/, src/domains/Permission/ |
| Acesso e membros | src/app/auth/, src/app/membership/, src/app/permission-admin/ | src/domains/Authentication/, src/domains/Membership/constants.js, policies.js, service.js |
| Remessas e despacho | src/app/shipments/, shipment.model.ts, shipment-errors.ts | src/domains/Shipment/state-machine.js, service.js, src/domains/Dispatch/ |
| Parceiros e contratação | src/app/carrier-connections/, partners/, operated-partners/ | src/domains/CarrierAccount/, FreightHub/, Partner/, OperatedPartner/ |
| Viagem rodoviária | src/app/trips/, src/app/freight-calculation/ | src/domains/RoadTrip/eligibility.js, trip-service.js, planning.js |
| Documentos fiscais | src/app/fiscal-core/, src/app/trips/trip-fiscal/ | src/domains/FiscalCore/providers/registry.js, cte/, mdfe/ |
| Financeiro | src/app/finance-freight/, src/app/mobility/ride-finance.model.ts | src/domains/Finance/, src/domains/Ride/payment.js |
| Veículos e documentos | src/app/vehicle/, drivers/, documents/ | src/domains/Vehicle/, DriverRecord/, Document/catalog.js |
| Manutenção e checklist | src/app/service-order/, maintenance-plans/, checklist/ | src/domains/ServiceOrder/, MaintenancePlan/, Checklist/ |
| Custos e indicadores | src/app/costs/, src/app/fleet-costs/ | src/domains/Cost/, src/domains/FleetReport/ |
| Jornada | src/app/journeys/ | src/domains/Journey/catalog.js |
| Mobilidade e corridas | src/app/mobility/ | src/domains/Mobility/, src/domains/Ride/catalog.js, service.js |
| Fretamento e QR | src/app/charter/ | src/domains/Charter/catalog.js, schedule.js, trip-state.js, checkin.js |
| App do passageiro | projects/passenger/src/app/, projects/passenger/README.md | src/domains/Passenger/, src/domains/Charter/portal.js |
| Coleta ambiental | src/app/gatherer-route/, receipt/, generator-receipt/, fiscal-receipt/ | src/domains/CollectRoute/, Route/, Receipt/, Gatherer/, Generator/, Fiscal/ |
Origem dos prints
As imagens do painel são capturadas do front compilado com belle-docs/scripts/capture-screenshots.mjs. O capturador reutiliza os helpers e perfis fictícios da auditoria visual do front e complementa os cenários de fretamento e mobilidade com fixtures locais. O manifesto seleciona as telas e o perfil de cada print. As imagens do passageiro vêm do smoke de navegador do próprio front, com sua API simulada.
Durante a captura, as chamadas da API são respondidas dentro do Chrome e o tráfego externo é bloqueado. Mapas e serviços externos podem aparecer indisponíveis nesse ambiente. Listas que não possuem dados na fixture podem aparecer vazias.
O catálogo de imagens em static/img/screenshots/manifest.json registra rota, perfil, viewport, revisão do código e origem da captura. Os prints usam a data fixa das fixtures, por isso os dias exibidos podem diferir da data de revisão do manual.
Manter atualizado
- Ao alterar uma funcionalidade, confira os passos, nomes e restrições do guia correspondente.
- Se houver mudança visual, gere novamente os prints da documentação.
- Use apenas dados de demonstração nas fixtures.
- Execute a verificação das imagens e o build do Docusaurus.
- Confira visualmente as páginas alteradas em desktop e celular.
Os comandos de execução e captura ficam no README.md do projeto belle-docs.
Referências do gerador
O portal usa a configuração documentada pelo Docusaurus, com tema clássico e diagramas Mermaid.