Files

Documentacao do ForgeLM

Esta pasta concentra a documentacao detalhada do projeto. O README.md da raiz funciona como ponto de entrada rapido; aqui ficam as referencias completas.

API e backend

  • api/overview.md - arquitetura do backend, crates envolvidos e comportamento geral da API
  • api/endpoints.md - referencia dos endpoints HTTP, payloads, respostas e erros
  • api/configuration.md - variaveis de ambiente, auth, CORS, aliases de modelo e perfis de runtime

CLI

  • cli/overview.md - como a CLI se encaixa no projeto, flags globais e formatos de saida
  • cli/commands.md - referencia de comandos, subcomandos, exemplos e limitacoes atuais

App desktop

  • app/overview.md - arquitetura geral do app Tauri e seus subsistemas
  • app/user-guide.md - guia de uso do runtime manager, selecao de modelos e chat
  • app/backend-commands.md - comandos Tauri expostos pelo backend do app

Documentacao para desenvolvedores

  • developer/architecture.md - mapa do workspace, relacao entre crates e fluxo entre API, CLI e app

Como navegar

  • Usuario final do app: comece em app/user-guide.md
  • Operacao da API/CLI: comece em api/overview.md e cli/overview.md
  • Contribuicao tecnica: comece em developer/architecture.md