Merge remote-tracking branch 'anoma/ray/jam-spec' into base

* anoma/ray/jam-spec: docs: jam format spec
eigerco · Dec 20, 2024 · a16560c · a16560c
2 parents ba2c2f0 + 79c5b28
commit a16560c
Show file tree

Hide file tree

Showing 22 changed files with 647 additions and 1 deletion.
diff --git a/apps/anoma_lib/lib/noun/jam.ex b/apps/anoma_lib/lib/noun/jam.ex
@@ -145,7 +145,7 @@ defmodule Noun.Jam do
             # and 0 is not a valid backref offset since it means
             # "the entire noun we are jamming". (it would be 0b111 anyway.)
             # offset 1 would be 0b11011, 2.5x the size
-            # so no cache update. 0s are never backreffed-to
+            # so no cache update. 0s are never back-reffed to
             {<<1::1, 0::1>>, cache, offset + 2}
 
           atom when Noun.is_noun_atom(atom) ->

diff --git a/documentation/analysis.livemd b/documentation/analysis.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./hoon/dumping.livemd)
    3. [Setting Up](./hoon/setting-up.livemd)
 5. [Analysis](./analysis.livemd)
+6. [Jam](./jam.livemd)
 
 ## Analysis
 

diff --git a/documentation/contributing.livemd b/documentation/contributing.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./hoon/dumping.livemd)
    3. [Setting Up](./hoon/setting-up.livemd)
 5. [Analysis](./analysis.livemd)
+6. [Jam](./jam.livemd)
 
 ## Contributing
 

diff --git a/documentation/contributing/examples-over-testing.livemd b/documentation/contributing/examples-over-testing.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Intro
 

diff --git a/documentation/contributing/git.livemd b/documentation/contributing/git.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Git
 

diff --git a/documentation/contributing/iex.livemd b/documentation/contributing/iex.livemd
@@ -21,6 +21,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Running multiple IEX's in the same Image/Environments
 

diff --git a/documentation/contributing/mnesia-vs-actor-state.livemd b/documentation/contributing/mnesia-vs-actor-state.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Where should state be stored
 

diff --git a/documentation/contributing/observer.livemd b/documentation/contributing/observer.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## How To use Observer
 

diff --git a/documentation/contributing/style-guide.livemd b/documentation/contributing/style-guide.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Structural Rules
 

diff --git a/documentation/contributing/testing.livemd b/documentation/contributing/testing.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Testing
 

diff --git a/documentation/contributing/testing/running-tests.livemd b/documentation/contributing/testing/running-tests.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../../hoon/dumping.livemd)
    3. [Setting Up](./../../hoon/setting-up.livemd)
 5. [Analysis](./../../analysis.livemd)
+6. [Jam](./../../jam.livemd)
 
 ## Intent
 

diff --git a/documentation/contributing/testing/writing-tests.livemd b/documentation/contributing/testing/writing-tests.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../../hoon/dumping.livemd)
    3. [Setting Up](./../../hoon/setting-up.livemd)
 5. [Analysis](./../../analysis.livemd)
+6. [Jam](./../../jam.livemd)
 
 ## Conventions
 

diff --git a/documentation/contributing/understanding-any-module.livemd b/documentation/contributing/understanding-any-module.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Figuring out what a module does
 

diff --git a/documentation/contributing/writing-documents.livemd b/documentation/contributing/writing-documents.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## The writing from within Anoma
 

diff --git a/documentation/hoon.livemd b/documentation/hoon.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./hoon/dumping.livemd)
    3. [Setting Up](./hoon/setting-up.livemd)
 5. [Analysis](./analysis.livemd)
+6. [Jam](./jam.livemd)
 
 ## About This Guide
 

diff --git a/documentation/hoon/calling.livemd b/documentation/hoon/calling.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Calling Conventions
 

diff --git a/documentation/hoon/dumping.livemd b/documentation/hoon/dumping.livemd
@@ -29,6 +29,7 @@ Mix.install([
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Dumping Nock
 

diff --git a/documentation/hoon/setting-up.livemd b/documentation/hoon/setting-up.livemd
@@ -23,6 +23,7 @@
    2. [Dumping](./../hoon/dumping.livemd)
    3. [Setting Up](./../hoon/setting-up.livemd)
 5. [Analysis](./../analysis.livemd)
+6. [Jam](./../jam.livemd)
 
 ## Getting a Good Hoon environment