joffrey-bion / livedoc

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

Unify global doc elements #93

Closed joffrey-bion closed 6 years ago

joffrey-bion commented 6 years ago

Changelogs and migrations are just a special cases of global documentation pages. I don't think there is much added value in enforcing a special formatting for these pages, just like there was no real value in having separate paragraphs in the global doc homepage (see https://github.com/joffrey-bion/livedoc/issues/92).

On the other hand, there is some value in allowing multiple global doc pages with user-defined titles, and a generated navigation side-panel. This would allow for more possibilities for the user, and simplify a lot the model, readers, and UI.