dandi / dandi/dandi-archive

Annotate design documents with the "state"

Open
#1,675 2 comments 1 reaction 0 assignees View on GitHub
DX maintenance
Dominant language
Python
Stars
26
Forks
21
Avg merge
4d 23h
Merged PRs (30d)
15

Description

We are accumulating design documents under https://github.com/dandi/dandi-archive/tree/master/doc/design which is great. But as time goes it becomes unclear on what is the destiny of each design document -- was it just proposed, being implemented superseded, etc. I propose to add some header structure, could be just a markdown list of keys like

- State: proposed (other values: work-in-progress, partially-implemented,implemented, abandoned, superseded; could be mixed, e.g., "implemented,superseded")
- Released-In: ``
- Superseded-By: ``
- Superseded-In: ``
- Implemented-In: ``

WDYT? I know that it would be a bit more of work, but would bring clarity since ATM not clear in what state we are in for each of those designed docs.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the design documents under doc/design and the proposed State, Released-In, Superseded-By, Superseded-In, and Implemented-In fields. First determine the agreed metadata structure and valid values from the issue discussion, then annotate the relevant documents consistently. Done means each design document clearly records its implementation status and related version, document, or pull-request references where applicable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.