Commit 2945bc5
committed
[ENH] Formalize presence of optional docs/ folder
Inspired by the success of the
#1962 adding
formalization of `logs/` folder, and triggered by the use-case in DANDI
dandi/dandi-docs#200 seeking to add more elaborate
descriptions to the README (or more specifically README.md), I would like to
propose adding any extra documentation and associated artwork (images, videos,
etc) under `docs/` folder. I do not think it is worth breaking down more (as
videos/) etc, since it could confuse with data types (videos of behavior or
alike).
Not sure if we would want to formalize inner structure anyhow. We could
potentially recommend using `docs/images/` subfolder for images.
Then README.md on top level could potentially use those images via
references to `docs/` paths.1 parent 5f56233 commit 2945bc5
File tree
3 files changed
+8
-0
lines changed- src
- schema/rules
- files/common
3 files changed
+8
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
392 | 392 | | |
393 | 393 | | |
394 | 394 | | |
| 395 | + | |
395 | 396 | | |
396 | 397 | | |
397 | 398 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
37 | 41 | | |
38 | 42 | | |
39 | 43 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
39 | 42 | | |
40 | 43 | | |
41 | 44 | | |
| |||
0 commit comments