digital-guard / preserv

Digital Preservation Project
http://git.digital-guard.org/preserv
Apache License 2.0
0 stars 0 forks source link

docs com diagramas UML inline Mermaid #85

Open ppKrauss opened 2 years ago

ppKrauss commented 2 years ago

Depois de cumprir os requisitos básicos da issue #84, iniciar documentação UML com Mermaid
Em uma implementação recente do Github, passamos a ter o recurso dos giagramas. Ver se isso será simples no mkdocs... Como usamos Material, ver mkdocs-material.

Exemplo de diagrama de dependência

https://github.com/AddressForAll/pg_pubLib-v1/blob/main/docs/install.md#dependencies

graph LR
    00-general --> 01-array & 01py-string --> 02-string --> 03-admin.sql & 03-json --> 04-aggregate
    04-aggregate --> 05hcode-distrib & 05pgis-extraSRID.sql & 05pgis-geohash.sql --> 06pgis-geoJSON 

O código-fonte do diagrama fica inline. Apenas uns poucos diagramas mais gerais do sistema inteiro precisam ser compostos por ferramentas como Visio, ou alguma ferramenta de customização SVG.