Ir para o conteúdo

HDT-AF Project Documentation

This directory gathers the project's technical documentation.

Instructions for LLM agents

Instructions for Codex, Claude, Copilot, and other agents are centralized in ../.agents/README.md. Files such as ../AGENTS.md, ../CLAUDE.md, ../codex/project-context.md, and ../.github/copilot-instructions.md are entry points to that shared source.

Practical guides

Guide Content
ARCHITECTURE.md Visão arquitetural consolidada, diagramas PlantUML de componentes e sequência, decisões arquiteturais e estrutura de diretórios
INSTALL.md Guia consolidado de pré-requisitos, instalação, variáveis de ambiente, execução local, testes e produção
tutorial-create-experiment.md End-to-end tutorial: experiment creation, data configuration, deployment, simulation run, and monitoring
execution-guide.md Prerequisites, build, run scripts, environment variables, generated outputs
experiments-guide.md Creating and running experiments: TrainingLocalModel, DataComponent, contract, monitor and Fabric integration
simulation-deployment-guide.md Consolidated operational flow for packaging, deploying to the monitor, and running the simulation by rounds or MQTT replay
vm-deployment-guide.md Guia completo de implantação em Máquina Virtual (VM 192.168.10.198): Docker Compose, dual-network bridging, Hyperledger Fabric, Mosquitto TLS e diagnóstico
Android federated client Multi-experiment Android client, MDPL DEX package, local CDDL bridge, build and tests
Official Docs Portal (Read the Docs) Portal oficial MkDocs Material / Read the Docs com busca, Mermaid, SVGs PlantUML pré-renderizados e referência OpenAPI
Project module inventory Active Maven, Gradle, and npm modules, experiment modules, and repository layout notes

Main indexes

Area Index
Components components/README.md
Model inference package and HTTP API components/20-model-inference.md
API (OpenAPI/Swagger) openapi-admin-monitor.yaml (API administrativa completa; servida em /openapi.yaml e /swagger-ui/) · cópia para leitura · openapi-hdt-client.yaml (rotas chamadas pelos participantes HDT)
Diagrams diagrams/README.md
MQTT mqtt/README.md
Blockchain blockchain/README.md
Privacy and LGPD components/03-hyperledger-fabric.md · components/06-federated-client.md · ../.agents/shared-rules.md
Technical analyses analysis/README.md
Project backlog ../backlog.md
Docker ../docker/README.md
Research ../research/README.md
Local data ../data/README.md
Presentation slides (Marp) slides/hdt-af-visao-geral.md

Maintenance rule

When a change affects architecture, components, flows, security, or execution, update the specific document and this index if new areas are created.