Merge pull request #3995 from daijingz/main

#2857 out-of-date README.md Update 2
JacquesCarette · Jan 6, 2025 · 2c11b14 · 2c11b14
2 parents 9e55dd6 + 9c3c8ad
commit 2c11b14
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 13 deletions.
diff --git a/code/drasil-build/lib/Build/Drasil/Make/README.md b/code/drasil-build/lib/Build/Drasil/Make/README.md
@@ -1,6 +1,6 @@
 ----------------------------------------------------------
 ### Quick Summary of Folder Structure and File Contents
-Last updated: July 20, 2018
+Last updated: December 30, 2024
 ----------------------------------------------------------
 
 AST.hs
@@ -12,6 +12,9 @@ Helpers.hs
 Import.hs
   - Translator for moving from Drasil AST to layout AST
 
+MakeString.hs
+  - Defines types and functions for generating Makefiles
+
 Print.hs
   - Defines the pretty printer for generating the Makefile from the AST representation
 

diff --git a/code/drasil-code/lib/README.md b/code/drasil-code/lib/README.md
@@ -8,3 +8,6 @@ Last updated: Sept. 15, 2021
 
 **Language**
   - Contains the code for Drasil
+
+README.md
+  - This file
diff --git a/code/drasil-database/lib/Database/Drasil/README.md b/code/drasil-database/lib/Database/Drasil/README.md
@@ -1,16 +1,13 @@
 --------------------------------------------------
 ### Summary of Folder Structure and File Contents
-Last updated: May 9, 2019
+Last updated: December 30, 2024
 --------------------------------------------------
 
-**ChunkDB**
-  - Contains helper functions for extracting information from chunk databases
-
 ChunkDB.hs
   - Chunk databases used by System Information for looking up knowledge
 
+Dump.hs
+  - Organizes all UIDs from Chunk databases into a structured map for debugging and analysis
+
 README.md
   - This file
-
-SystemInformation.hs
-  - Defines the SI type
diff --git a/code/drasil-docLang/lib/Drasil/DocumentLanguage/README.md b/code/drasil-docLang/lib/Drasil/DocumentLanguage/README.md
@@ -1,21 +1,21 @@
 --------------------------------------------------
 ### Summary of Folder Structure and File Contents
-Last updated: August 16, 2021
+Last updated: December 30, 2024
 --------------------------------------------------
 
 **Notebook**
   - Defines helper types and functions to create the document language for generating lesson plans through Jupyter notebooks.
 
+Core.hs
+  - Defines core types for use with the Drasil document language ("Drasil.DocumentLanguage").
+
 Definitions.hs
   - Defines types and functions to help generate some Solution Characteristics Specification subsections.
 
 README.md
   - This file
 
-RefHelpers.hs
-  - Contains helpers for referencing.
-
-TraceabilityMatrix.hs
+TraceabilityGraph.hs
   - Contains functions to build traceability graphs.
 
 TraceabilityMatrix.hs

diff --git a/code/drasil-gen/lib/README.md b/code/drasil-gen/lib/README.md
@@ -5,3 +5,6 @@ Last updated: Sept. 15, 2021
 
 **Language**
   - Contains the generation file(s) for actually generating code
+
+README.md
+  - This file