abathur / ldmud-doc

A temporary repo for working on a revamp of the documentation system for http://github.com/ldmud/ldmud
0 stars 0 forks source link

Do we need to include <version>vs<version> docs in the parsed/generated output? #17

Open abathur opened 9 years ago

abathur commented 9 years ago

This initial question can save us some time; do we need them at all outside of the source?

If we do, they present a small semantic issue in relation to the rest of the docs. 3.2vs3.2.1 uses the typical formatting, while the 3.3vs3.5 directory doesn't follow this format (and the use of the directory complicates things some.) Regardless, there's not an existing directive that conveys, "this details the difference between two versions."

The easiest course is to just let them be simple reST docs with non-semantic markup and manually add them to the TOC if desired. They wouldn't look like the rest of the docs, but that's already true of the 3.3vs3.5 folder anyways. If we want them collected in their own index of version-change-notes, easy to reference as such, etc., we'll need to come up with something that conveys appropriate semantics.