Updated to v 0.2.0

- docum. on impl. inside impl. folder - discarded designDetailsFile field
Archaeology-ABM · Sep 8, 2022 · 1f811b0 · 1f811b0
1 parent d73b696
commit 1f811b0
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1 +1,3 @@
+- V 0.2.0: Moved documentation on implementation to inside the implementation directory. In NASSA.yml: specify in 'docsDir' description that it refers to the directory name of both the general and the implementation-specific documentation directories; discarded 'designDetailsFile' field.
+
 - V 0.1.0: First schema consolidated, made compatible with nassa-hs and files in NASSA modules so far
diff --git a/README.md b/README.md
@@ -15,13 +15,12 @@ YYYY-SURNAME-001 (module root)
 │
 └───documentation
 │   │   tableOfContents.md
-│   │
-│   └───<IMPLEMENTATION LANGUAGE>
-│       │   tableOfContents.md
-│       │   ... (minimum depending on language)
 │   
 └───<IMPLEMENTATION LANGUAGE>
     │   moduleShortTitle.<LANGUAGE EXTENSION>
+    │
+    └───documentation
+        │   tableOfContents.md
 ```
 
 ### Maximum (can have)
@@ -39,29 +38,15 @@ YYYY-SURNAME-001 (module root)
 │   │   tableOfContents.md
 │   │   designDetails.md
 |   │   ...
+│   
+└───netlogo_implementation
+│   │   moduleShortTitle.nlogo
 │   │
-│   └───netlogo
+│   └───documentation
 │   |   │   tableOfContents.md
 │   |   │   instructions.md
 │   |   │   moduleTitle interface.png
 │   |   │   ...
-│   |
-│   └───python
-│   |   │   tableOfContents.md
-│   |   │   instructions.md
-│   |   │   diagram.png
-│   |   │   ...
-│   |
-│   └───r
-│   |   │   tableOfContents.md
-│   |   │   instructions.md
-│   |   │   pseudoCode.txt
-│   |   │   ...
-|   |
-|   |   ... (other implementations)
-│   
-└───netlogo_implementation
-│   │   moduleShortTitle.nlogo
 │   │
 │   └───input
 │   │   │   aDataset.csv
@@ -77,6 +62,12 @@ YYYY-SURNAME-001 (module root)
 │   │   moduleShortTitle.py
 │   │   demonstration.ipynb
 |   |   ...
+│   |
+│   └───documentation
+│   |   │   tableOfContents.md
+│   |   │   instructions.md
+│   |   │   diagram.png
+│   |   │   ...
 │   │
 │   └───input
 │   │   │   aDataset.csv
@@ -94,6 +85,12 @@ YYYY-SURNAME-001 (module root)
 │   │   demonstration.html
 │   │   demonstration.md
 |   |   ...
+│   |
+│   └───documentation
+│   |   │   tableOfContents.md
+│   |   │   instructions.md
+│   |   │   pseudoCode.txt
+│   |   │   ...
 |   |
 │   └───demonstration_files
 │   │   │   unnamed-chunk-5-1.png
@@ -156,7 +153,6 @@ YYYY-SURNAME-001 (module root)
 | unit                 | 1     | outputs         | Variable/object unit of measurement, if applicable.                                                                                                                                                                                                                             | String | free text                                                                                                                                                            | false     |
 | description          | 1     | outputs         | Variable/object description. Meaning, data structure, or any other relevant information for data analysis and interpretation or the use of the output as input in another module.                                                                                               | String | free text                                                                                                                                                            | false     |
 | readmeFile           | 0     |                 | Relative path to Readme.md or alike, which contains at least the information specified in the NASSA template (<url placeholder>).                                                                                                                                               | String | path                                                                                                                                                                 | false     |
-| docsDir              | 0     |                 | Relative path to the directory containing documentation resources.                                                                                                                                                                                                              | String | path                                                                                                                                                                 | false     |
-| designDetailsFile    | 0     |                 | Relative path to the design details file. Recommended NASSA template: <url placeholder>                                                                                                                                                                                         | String | path                                                                                                                                                                 | false     |
+| docsDir              | 0     |                 | Relative path to the directory containing the general documentation resources. The same directory name should be also use inside implementations directories to contain implementation-specific documentation resources (see 'Module file structure' above).                                                                                                                                                                                                              | String | path                                                                                                                                                                 | false     |
 
 (generated with https://kdelmonte.github.io/json-to-markdown-table/)
diff --git a/nassa-schema.json b/nassa-schema.json
@@ -367,14 +367,5 @@
    "type": "String",
    "format": "path",
    "mandatory": false
- },
- {
-   "field": "designDetailsFile",
-   "level": 0,
-   "parent": "",
-   "description": "Relative path to the design details file. Recommended NASSA template: <url placeholder>",
-   "type": "String",
-   "format": "path",
-   "mandatory": false
  }
 ]