Migrate from "MarkDown" to a well-specified doc format #125
Conversation
|
The problem is this thing will not be displayed by Github as original one was. |
|
Does it matter? XML is designed to be readable by both humans and computers, so I say it's a win-win situation. |
|
I seriously doubt that switching from a readme displayed inline to one not displayed inline is a win-win even for a serious business. |
|
While we appreciate the careful crafting that went into this pull request and regard XML as an excellent choice for documenting projects of Enterprise caliber, we feel that moving to Docbook version 5 is a rather hasty move. The version is brand new, and we are unable to convince stakeholders about its Enterprise-grade integrity and long-term prospects as a documentation platform. |
|
Escalated to product owner backlog |
|
We could use http://johnmacfarlane.net/pandoc/ as part of the build process to generate the markdown suitable for Github. Since we've migrated to Maven, adding additional dependencies should be fairly straight forward. |
Thanks!