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 document/code "status" is handled #10

Closed abathur closed 7 years ago

abathur commented 8 years ago

A number of existing docs use the first line to declare a status of some sort (generally: optional, preliminary/experimental, and deprecated/obsolete/removed). Additionally, everything in the "obsolete" directory has a sort of implicit status which is hard to untangle from the OBSOLETE line. Going over these docs has exposed some weirdness and contradiction to me that suggests we should maybe rethink how status is conveyed.

Here's a short list of some of the smells/weirdness that make me think there are underlying conceptual problems:

I'll follow up with my first take on what we could do with these (eventually), but I'm also hesitant to guide the discussion too heavily at the start, since I realize I may not be able to see the forest for the trees at the moment.

This issue is related to some others:

abathur commented 7 years ago

I think this issue was a little to meta and gets implicitly decided in the process of #11 and #12.