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

How should document status be presented? #12

Open abathur opened 9 years ago

abathur commented 9 years ago

With the magic going on behind a document-generation system, it's possible for us to more heavily modify a document that has a different status. The old form looked like:

DEPRECATED
SYNOPSIS...

The current form I'm using (this is just a bit easier within sphinx/docutils logistics) is:

SYNOPSIS (DEPRECATED)
...

But the "point" is that DEPRECATED could probably be a link to a concept/topic page for deprecation, or it could trigger the insertion of a box/section that provides a gloss of what deprecation is and how to use it. There could also be a way to indicate whether there's a replacement, and link to it if so.

abathur commented 7 years ago

Calling this decided, but not in a hurry to implement it. I'd like these types to link to their own meta documentation that unambiguously states what each status means (and, for convenience, collects a list of docs/defs with that status).