Avaliar opções de sintaxe para endpoints de documentação

[ppKrauss]

Decidir o que fazer com

• docs.addressforall.org, extinguir? Ou jogar para os docs (pasta /docs) de cada projeto. Por exemplo docs.addressforall.org/WS apontaria para o index de git/WS/docs e docs.addressforall.org/digital-preservartion para git/digital-preservartion/docs

• spec.addressforall.org, extinguir? poderia ser docs.addressforall.org/specifications ....

---

Como estava inicialmente previsto:

A documentação das APIs (microservices) e demais web services (ex. downloads) será ofertada de dois modos:

1. pareando a cada api.addressforall.org/v1.json/x o seu api.addressforall.org/v1.htm/x, ou seja, ofertando HTML em contrapartida ao JSON, com exatamente mesma sintaxe de chamada x, mas com resposta bem diferente: páginas navegáveis com rodapé indicando ao programador qual foi de fato o endpoint evocado.

2. ofertando tutoriais das APIs em api.addressforall.org/v1/_man/xyz, onde xyz não é apenas um comando, mas uma diretiva ou um processo envolvendo mais de um endpoint... Por outro lado o _man pode ser uma página enchuta indicando links para /v1.htm/x ou specs ou docs.