scaled transaction graph with scroll and docs naming cleanup

kuznia-rdzeni · Nov 21, 2023 · 942855e · 942855e
1 parent 41d1b8c
commit 942855e
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 18 deletions.
diff --git a/docs/Current_graph.md b/docs/Current_graph.md
diff --git a/docs/Assumptions.md → docs/assumptions.md b/docs/Assumptions.md → docs/assumptions.md
diff --git a/docs/current-graph.md b/docs/current-graph.md
@@ -0,0 +1,12 @@
+# Full transaction-method graph
+
+<div style="overflow: scroll; white-space: nowrap; border=20px solid red">
+<div style="width: 2000%; height: 2000%">
+
+   ```{eval-rst}
+   .. include:: auto_graph.rst
+      
+   ```
+
+</div>
+</div>
diff --git a/docs/Development_environment.md → docs/development-environment.md b/docs/Development_environment.md → docs/development-environment.md
diff --git a/docs/Home.md → docs/home.md b/docs/Home.md → docs/home.md
diff --git a/docs/index.md b/docs/index.md
@@ -5,17 +5,17 @@
 maxdepth: 3
 ---
 
-Home.md
-Assumptions.md
-Development_environment.md
-Transactions.md
-scheduler/Overview.md
-shared_structs/Implementation/RS_impl.md
-shared_structs/RS.md
-Current_graph.md
-Problem-checklist.md
-synthesis/Synthesis.md
+home.md
+assumptions.md
+development_environment.md
+transactions.md
+scheduler/overview.md
+shared_structs/implementation/rs_impl.md
+shared_structs/rs.md
+current_graph.md
+problem_checklist.md
+synthesis/synthesis.md
 components/icache.md
-miscellany/exceptionsSummary.md
+miscellany/exceptions_summary.md
 api.md
 ```
diff --git a/docs/miscellany/exceptionsSummary.md → docs/miscellany/exceptions-summary.md b/docs/miscellany/exceptionsSummary.md → docs/miscellany/exceptions-summary.md
diff --git a/docs/Problem-checklist.md → docs/problem-checklist.md b/docs/Problem-checklist.md → docs/problem-checklist.md
@@ -10,6 +10,6 @@ If something doesn't work and you're puzzled as to why - go through this checkli
 
 4. Make sure all amaranth statements are added to some domain.
 
-5. Check if your code doesn't have any combinational loops - especially if your simulation hangs.
+5. Check if your code doesn't have any combinational boobs - especially if your simulation hangs.
 
 Please extend this list if you spot yourself doing an easy-to-fix mistake.
diff --git a/docs/scheduler/Overview.md → docs/scheduler/overview.md b/docs/scheduler/Overview.md → docs/scheduler/overview.md
diff --git a/.../shared_structs/Implementation/RS_impl.md → .../shared-structs/implementation/rs-impl.md b/.../shared_structs/Implementation/RS_impl.md → .../shared-structs/implementation/rs-impl.md
diff --git a/docs/shared_structs/RS.md → docs/shared-structs/rs.md b/docs/shared_structs/RS.md → docs/shared-structs/rs.md
diff --git a/docs/synthesis/Synthesis.md → docs/synthesis/synthesis.md b/docs/synthesis/Synthesis.md → docs/synthesis/synthesis.md
diff --git a/docs/Transactions.md → docs/transactions.md b/docs/Transactions.md → docs/transactions.md
@@ -64,7 +64,7 @@ class MyOtherThing(Elaboratable):
         ...
 
         # Declaration of the method.
-        # The i/o parameters pass the format of method argument/result as Amaranth layouts.
+        # The i/o parameters ass the format of method argument/result as Amaranth layouts.
         # Both parameters are optional.
 
         self.my_method = Method(i=input_layout, o=output_layout)