Skip to content

Commit a7dd34a

Browse files
authored
Merge pull request #2104 from yarikoptic/enh-docs
[ENH] Formalize presence of optional docs/ folder
2 parents 55364c2 + 2945bc5 commit a7dd34a

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

src/common-principles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,7 @@ Derivatives can be stored/distributed in two ways:
392392
that were used to generate the derivatives.
393393
Likewise, any code used to generate the derivatives from the source data
394394
MAY be included in the `code/` subdirectory.
395+
Extra documentation (and relevant images) MAY be included in the `docs/` subdirectory.
395396
Logs from running the code or other commands MAY be stored under `logs/` subdirectory.
396397
397398
Example of a derivative dataset including the raw dataset as source:

src/schema/rules/directories.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ raw:
3434
name: derivatives
3535
level: optional
3636
opaque: true
37+
docs:
38+
name: docs
39+
level: optional
40+
opaque: true
3741
logs:
3842
name: logs
3943
level: optional

src/schema/rules/files/common/core.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ code:
3636
derivatives:
3737
level: optional
3838
path: derivatives
39+
docs:
40+
level: optional
41+
path: docs
3942
logs:
4043
level: optional
4144
path: logs

0 commit comments

Comments
 (0)