rodolpho/apitdn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize comprehensive documentation and MCP guide

Browse Source
This commit is contained in:
rodolpho
2026-05-07 18:52:03 -03:00
parent 4d689ad6f3
commit 0f3778e3e8
2 changed files with 83 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
index.md
+27 -11
View File
@@ -1,16 +1,32 @@
# Bem-vindo à sua Wiki Técnica Fluig Offline
# Wiki Técnica Fluig Offline & MCP Server
Esta base de dados contém toda a documentação técnica extraída do TDN, otimizada para consulta rápida e uso em modelos de IA locais.
Esta é uma base de conhecimento técnica completa da plataforma TOTVS Fluig, extraída automaticamente do TDN e otimizada para desenvolvedores e sistemas de IA.
### Atalhos Rápidos
* [Desenvolvimento de Datasets](Plataforma Documentação técnica/Desenvolvimento sobre a plataforma/Desenvolvimento de Datasets/Construção do Dataset Avançado.md)
* [Eventos de Processo (BPM)](Plataforma Documentação técnica/Recurso de Processos (BPM).md)
* [Guia de Estilos (Style Guide)](Plataforma Documentação técnica/Desenvolvimento sobre a plataforma/Guia de Estilos.md)
## 🚀 Funcionalidades Principais
* **Extração Inteligente:** Motor assíncrono que mantém a documentação sempre atualizada com o TDN.
* **Wiki Offline:** Interface visual moderna via MkDocs para consulta rápida sem internet.
* **Biblioteca de Snippets:** Todos os exemplos de código (JS, Java, SQL) extraídos e categorizados.
* **Pronto para IA (RAG):** Documentação dividida em chunks semânticos para alimentar modelos de linguagem.
* **Servidor MCP:** Interface nativa para integrar o conhecimento do Fluig diretamente no seu chat de IA.
### Recursos Offline e IA
* **Biblioteca de Snippets:** Veja exemplos de [JS](Biblioteca de Snippets/Snippets JAVASCRIPT.md), [Java](Biblioteca de Snippets/Snippets JAVA.md) e [SQL](Biblioteca de Snippets/Snippets SQL.md).
* **RAG Ready:** Use o `rag_processor.py` para gerar chunks para sua IA local.
* **Manutenção:** Rode `link_validator.py` para garantir que nada esteja quebrado.
## 📂 Estrutura do Projeto
* `fluig_extractor.py`: O motor de extração (Async + Incremental).
* `fluig_rag_docs/`: A base de arquivos Markdown e imagens.
* `mcp_server.py`: O servidor para conexão com IAs.
* `rag_processor.py`: Gerador de chunks para sistemas RAG.
* `snippet_generator.py`: Extrator de exemplos de código.
* `Dockerfile`: Ambiente pronto para deploy da Wiki.
## 🛠️ Como Começar
1. **Instalação:** `pip install -r requirements.txt`
2. **Ver a Wiki:** `mkdocs serve` e acesse `http://localhost:8000`
3. **Configurar MCP:** Veja o [Guia do MCP](MCP_GUIDE.md).
---
*Gerado automaticamente para uso via Tailscale.*
### 🔗 Atalhos Rápidos
* [Desenvolvimento de Datasets](Plataforma Documentação técnica/Desenvolvimento sobre a plataforma/Desenvolvimento de Datasets/Construção do Dataset Avançado.md)
* [Eventos de Processo (BPM)](Plataforma Documentação técnica/Recurso de Processos (BPM).md)
* [Biblioteca de Snippets JS](Biblioteca de Snippets/Snippets JAVASCRIPT.md)
---
*Este projeto visa acelerar o desenvolvimento na plataforma Fluig através de engenharia de conhecimento avançada.*