add archive for old docs

internetofwater · Nov 19, 2024 · d43dada · d43dada
1 parent 7b0f00b
commit d43dada
Show file tree

Hide file tree

Showing 8 changed files with 5 additions and 1 deletion.
diff --git a/docs/GleanerConfig.md → docs/archive/GleanerConfig.md b/docs/GleanerConfig.md → docs/archive/GleanerConfig.md
diff --git a/docs/GleanerPoster.pdf → docs/archive/GleanerPoster.pdf b/docs/GleanerPoster.pdf → docs/archive/GleanerPoster.pdf
diff --git a/docs/P419Report.pdf → docs/archive/P419Report.pdf b/docs/P419Report.pdf → docs/archive/P419Report.pdf
diff --git a/docs/SourceAPI.md → docs/archive/SourceAPI.md b/docs/SourceAPI.md → docs/archive/SourceAPI.md
diff --git a/docs/SourceSitemap.md → docs/archive/SourceSitemap.md b/docs/SourceSitemap.md → docs/archive/SourceSitemap.md
diff --git a/docs/buildrun.md → docs/archive/buildrun.md b/docs/buildrun.md → docs/archive/buildrun.md
diff --git a/docs/sitemaps.md → docs/archive/sitemaps.md b/docs/sitemaps.md → docs/archive/sitemaps.md
diff --git a/docs/internals.md b/docs/internals.md
@@ -1,5 +1,7 @@
 # Gleaner Internals
 
+This document describes the internal workings of Gleaner. The rest of the old documentation has been moved into the [`archive`](./archive/) folder given the fact that some was outdated.
+
 ## Walkthrough of the e2e path
 
 1. Read in CLI arguments with Viper
@@ -14,7 +16,9 @@
 4. Summon the sitemaps
     1. Get all the sources in the gleaner config of type API
     2. Run ResRetrieve to pull down the data graphs at resources
-        - For each url associated with a given domain, spawn a go routine with getDomain
+        - For each url associated with a given domain, spawn a go routine with `getDomain`
+
+TODO: There is more code after this that can be further documented, but these may be refactored as the codebase matures and is in goroutines making in slightly harder to reason about. 
 
 ## Properties