joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services
MIT License
4 stars 2 forks source link

Remove unnecessary paragraph separation in Global doc #92

Closed joffrey-bion closed 6 years ago

joffrey-bion commented 6 years ago

This separation is arbitrary. The only point is to provide some sort of default HTML structure, but this is very little added value compared to the constraint that this represents. If the user decides to use paragraphs, then he might as well write the HTML for it himself.

A counter-argument would be that this separation allowed the split of the paragraphs into multiple files (because each paragraph could load files separately). That's true, but this split is forced onto the user. Most of the time, the user will want to decide for himself what to split. This will be handled in the scope of https://github.com/joffrey-bion/livedoc/issues/90 .