chore: Clean docs directory and top level md files (#12774)

- Clean up the top level and `docs` directory a bit - Some of these image files are being used by the Wiki, and will be moved on merge of this PR (TODO)
erigontech · Nov 19, 2024 · af5adad · af5adad
1 parent 400de4c
commit af5adad
Show file tree

Hide file tree

Showing 23 changed files with 3 additions and 3 deletions.
diff --git a/DEV_CHAIN.md → docs/DEV_CHAIN.md b/DEV_CHAIN.md → docs/DEV_CHAIN.md
diff --git a/TESTING.md → docs/TESTING.md b/TESTING.md → docs/TESTING.md
diff --git a/docs/Coherence.png → docs/asssets/Coherence.png b/docs/Coherence.png → docs/asssets/Coherence.png
diff --git a/docs/Consensus-Engine-Page-1.png → docs/asssets/Consensus-Engine-Page-1.png b/docs/Consensus-Engine-Page-1.png → docs/asssets/Consensus-Engine-Page-1.png
diff --git a/docs/Consensus-Engine-Page-2.png → docs/asssets/Consensus-Engine-Page-2.png b/docs/Consensus-Engine-Page-2.png → docs/asssets/Consensus-Engine-Page-2.png
diff --git a/docs/Consensus-Engine-Page-3.png → docs/asssets/Consensus-Engine-Page-3.png b/docs/Consensus-Engine-Page-3.png → docs/asssets/Consensus-Engine-Page-3.png
diff --git a/docs/Consensus-Engine-Page-4.png → docs/asssets/Consensus-Engine-Page-4.png b/docs/Consensus-Engine-Page-4.png → docs/asssets/Consensus-Engine-Page-4.png
diff --git a/docs/Consensus-Engine-Page-5.png → docs/asssets/Consensus-Engine-Page-5.png b/docs/Consensus-Engine-Page-5.png → docs/asssets/Consensus-Engine-Page-5.png
diff --git a/docs/Pool-eip1559.png → docs/asssets/Pool-eip1559.png b/docs/Pool-eip1559.png → docs/asssets/Pool-eip1559.png
diff --git a/docs/Subpools.png → docs/asssets/Subpools.png b/docs/Subpools.png → docs/asssets/Subpools.png
diff --git a/docs/arch2.png → docs/asssets/arch2.png b/docs/arch2.png → docs/asssets/arch2.png
diff --git a/docs/cfg1.png → docs/asssets/cfg1.png b/docs/cfg1.png → docs/asssets/cfg1.png
diff --git a/docs/erigon2_profile.png → docs/asssets/erigon2_profile.png b/docs/erigon2_profile.png → docs/asssets/erigon2_profile.png
diff --git a/docs/mgr-sync-1.png → docs/asssets/mgr-sync-1.png b/docs/mgr-sync-1.png → docs/asssets/mgr-sync-1.png
diff --git a/docs/minimal-perfect.png → docs/asssets/minimal-perfect.png b/docs/minimal-perfect.png → docs/asssets/minimal-perfect.png
diff --git a/docs/perfect-hash.png → docs/asssets/perfect-hash.png b/docs/perfect-hash.png → docs/asssets/perfect-hash.png
diff --git a/docs/pos_downloader.png → docs/asssets/pos_downloader.png b/docs/pos_downloader.png → docs/asssets/pos_downloader.png
diff --git a/docs/regular-hash.png → docs/asssets/regular-hash.png b/docs/regular-hash.png → docs/asssets/regular-hash.png
diff --git a/docs/stagedsync_proportions.png → docs/asssets/stagedsync_proportions.png b/docs/stagedsync_proportions.png → docs/asssets/stagedsync_proportions.png
diff --git a/docs/state_composition.png → docs/asssets/state_composition.png b/docs/state_composition.png → docs/asssets/state_composition.png
diff --git a/docs/tx_types.png → docs/asssets/tx_types.png b/docs/tx_types.png → docs/asssets/tx_types.png
diff --git a/docs/merry-go-round-sync.md b/docs/merry-go-round-sync.md
@@ -17,7 +17,7 @@ Cycle is divided into ticks. For convenience, we can say that each ticks starts
 for some predetermined amount of time, let's say, 30 seconds. This definition means that the ticks will often overlap, but not
 always, as shown on the picture below.
 
-![cycles-and-ticks](mgr-sync-1.png)
+![cycles-and-ticks](./asssets/mgr-sync-1.png)
 
 If chain reorgs occur, and the timings of recent Ethereum blocks change as a result, we can accept these rules to prevent
 the reorgs to be used to disrupt the sync. Imagine the tick started at block A (height H), and then due to reorg, block A

diff --git a/eth/stagedsync/README.md b/eth/stagedsync/README.md
@@ -28,7 +28,7 @@ Here is a pie chart showing the proportional time spent on each stage (it was
 taken from the full sync). It is by all means just an estimation, but it gives
 an idea.
 
-![Full sync breakdown](/docs/stagedsync_proportions.png)
+![Full sync breakdown](/docs/assets/stagedsync_proportions.png)
 
 ## Reorgs / Unwinds
 
@@ -61,7 +61,7 @@ This optimization sometimes leads to dramatic (orders of magnitude) write speed
 ## What happens after the Merge?
 
 In the Proof-of-Stake world staged sync becomes somewhat more complicated, as the following diagram shows.
-![Staged Sync in PoS](/docs/pos_downloader.png)
+![Staged Sync in PoS](/docs/assets/pos_downloader.png)
 
 ## Stages (for the up to date list see [`stages.go`](/eth/stagedsync/stages/stages.go) and [`stagebuilder.go`](/eth/stagedsync/stagebuilder.go))