From 08b4649374c70e0ece8fd6d3616061c493b5d0e9 Mon Sep 17 00:00:00 2001 From: Julien Eluard Date: Thu, 25 Apr 2024 16:32:47 +0200 Subject: [PATCH 1/2] fix: no more broken images --- docs/docusaurus.config.ts | 4 ++-- docs/pages/tools/flamegraphs.md | 14 +++++++------- docs/pages/tools/heap-dumps.md | 6 +++--- docs/static/{img => images}/favicon.ico | Bin .../images/flamescope/filtered-flamegraph.png | Bin .../images/flamescope/home-screen.png | Bin .../images/flamescope/selecting-series.png | Bin .../images/flamescope/time-series-view.png | Bin .../images/flamescope/unfiltered-flamegraph.png | Bin docs/{ => static}/images/flamescope/zoom-in.png | Bin docs/{ => static}/images/gitflow-lodestar.png | Bin docs/{ => static}/images/heap-dumps/devtools.png | Bin .../images/heap-dumps/load-profile.png | Bin .../{ => static}/images/heap-dumps/memory-tab.png | Bin docs/{ => static}/images/lodestar-releases.png | Bin docs/static/{img => images}/logo.png | Bin 16 files changed, 12 insertions(+), 12 deletions(-) rename docs/static/{img => images}/favicon.ico (100%) rename docs/{ => static}/images/flamescope/filtered-flamegraph.png (100%) rename docs/{ => static}/images/flamescope/home-screen.png (100%) rename docs/{ => static}/images/flamescope/selecting-series.png (100%) rename docs/{ => static}/images/flamescope/time-series-view.png (100%) rename docs/{ => static}/images/flamescope/unfiltered-flamegraph.png (100%) rename docs/{ => static}/images/flamescope/zoom-in.png (100%) rename docs/{ => static}/images/gitflow-lodestar.png (100%) rename docs/{ => static}/images/heap-dumps/devtools.png (100%) rename docs/{ => static}/images/heap-dumps/load-profile.png (100%) rename docs/{ => static}/images/heap-dumps/memory-tab.png (100%) rename docs/{ => static}/images/lodestar-releases.png (100%) rename docs/static/{img => images}/logo.png (100%) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 8c86ac4405ba..73940bc443aa 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -8,7 +8,7 @@ import {themes as prismThemes} from "prism-react-renderer"; const config: Config = { title: "Lodestar", tagline: "TypeScript Implementation of Ethereum Consensus", - favicon: "img/favicon.ico", + favicon: "images/favicon.ico", // Set the production url of your site here url: "https://chainsafe.github.io/", @@ -55,7 +55,7 @@ const config: Config = { title: "Lodestar Documentation", logo: { alt: "Lodestar Logo", - src: "img/logo.png", + src: "images/logo.png", }, items: [ { diff --git a/docs/pages/tools/flamegraphs.md b/docs/pages/tools/flamegraphs.md index eff71ed946d7..10fe0c707dd3 100644 --- a/docs/pages/tools/flamegraphs.md +++ b/docs/pages/tools/flamegraphs.md @@ -108,11 +108,11 @@ yarn dev Then navigate in a browser to `http://localhost:8080` and begin analyzing the data. -flamescope home screen -flamescope home screen -flamescope home screen -flamescope home screen -flamescope home screen +![flamescope home screen](/images/flamescope/home-screen.png) +![flamescope time series view](/images/flamescope/time-series-view.png) +![flamescope selecting series](/images/flamescope/selecting-series.png) +![flamescope unfiltered flamegraph](/images/flamescope/unfiltered-flamegraph.png) +![flamescope zoom in](/images/flamescope/zoom-in.png) ## Filtering Results @@ -124,11 +124,11 @@ sed -r -e "/( __libc_start| uv_| LazyCompile | v8::internal::| node::| Builtins_ ### Unfiltered -flamescope home screen +![flamescope unfiltered flamegraph](/images/flamescope/unfiltered-flamegraph.png) ### Filtered -flamescope home screen +![flamescope filtered flamegraph](/images/flamescope/filtered-flamegraph.png) ## References diff --git a/docs/pages/tools/heap-dumps.md b/docs/pages/tools/heap-dumps.md index ece8f8f54b77..7e6bcfeda667 100644 --- a/docs/pages/tools/heap-dumps.md +++ b/docs/pages/tools/heap-dumps.md @@ -34,15 +34,15 @@ curl -X POST http://localhost:9596/eth/v1/lodestar/write_heapdump?dirpath=/some/ It is best to analyze on a local development machine so if Lodestar is running on a cloud instance download the dump to the local environment. Open Chrome, or any Chromium based browser (the example photos were taken using Brave). In the url bar type `chrome:://inspect` to bring up the DevTools menu (in brave the url will be rewritten to `brave://inspect`). -![DevTools](../../images/heap-dumps/devtools.png) +![DevTools](/images/heap-dumps/devtools.png) Click on the `Open dedicated DevTools for Node` link to open the node specific window and click on the `Memory` tab as shown below. -![Memory Tab](../../images/heap-dumps/memory-tab.png) +![Memory Tab](/images/heap-dumps/memory-tab.png) Load the profile by either right clicking on the left pane or by clicking the `Load` button at the bottom. -![Load Profile](../../images/heap-dumps/load-profile.png) +![Load Profile](/images/heap-dumps/load-profile.png) ### Analyzing a `V8` heap dump diff --git a/docs/static/img/favicon.ico b/docs/static/images/favicon.ico similarity index 100% rename from docs/static/img/favicon.ico rename to docs/static/images/favicon.ico diff --git a/docs/images/flamescope/filtered-flamegraph.png b/docs/static/images/flamescope/filtered-flamegraph.png similarity index 100% rename from docs/images/flamescope/filtered-flamegraph.png rename to docs/static/images/flamescope/filtered-flamegraph.png diff --git a/docs/images/flamescope/home-screen.png b/docs/static/images/flamescope/home-screen.png similarity index 100% rename from docs/images/flamescope/home-screen.png rename to docs/static/images/flamescope/home-screen.png diff --git a/docs/images/flamescope/selecting-series.png b/docs/static/images/flamescope/selecting-series.png similarity index 100% rename from docs/images/flamescope/selecting-series.png rename to docs/static/images/flamescope/selecting-series.png diff --git a/docs/images/flamescope/time-series-view.png b/docs/static/images/flamescope/time-series-view.png similarity index 100% rename from docs/images/flamescope/time-series-view.png rename to docs/static/images/flamescope/time-series-view.png diff --git a/docs/images/flamescope/unfiltered-flamegraph.png b/docs/static/images/flamescope/unfiltered-flamegraph.png similarity index 100% rename from docs/images/flamescope/unfiltered-flamegraph.png rename to docs/static/images/flamescope/unfiltered-flamegraph.png diff --git a/docs/images/flamescope/zoom-in.png b/docs/static/images/flamescope/zoom-in.png similarity index 100% rename from docs/images/flamescope/zoom-in.png rename to docs/static/images/flamescope/zoom-in.png diff --git a/docs/images/gitflow-lodestar.png b/docs/static/images/gitflow-lodestar.png similarity index 100% rename from docs/images/gitflow-lodestar.png rename to docs/static/images/gitflow-lodestar.png diff --git a/docs/images/heap-dumps/devtools.png b/docs/static/images/heap-dumps/devtools.png similarity index 100% rename from docs/images/heap-dumps/devtools.png rename to docs/static/images/heap-dumps/devtools.png diff --git a/docs/images/heap-dumps/load-profile.png b/docs/static/images/heap-dumps/load-profile.png similarity index 100% rename from docs/images/heap-dumps/load-profile.png rename to docs/static/images/heap-dumps/load-profile.png diff --git a/docs/images/heap-dumps/memory-tab.png b/docs/static/images/heap-dumps/memory-tab.png similarity index 100% rename from docs/images/heap-dumps/memory-tab.png rename to docs/static/images/heap-dumps/memory-tab.png diff --git a/docs/images/lodestar-releases.png b/docs/static/images/lodestar-releases.png similarity index 100% rename from docs/images/lodestar-releases.png rename to docs/static/images/lodestar-releases.png diff --git a/docs/static/img/logo.png b/docs/static/images/logo.png similarity index 100% rename from docs/static/img/logo.png rename to docs/static/images/logo.png From 4f5519546ad0742809734443e61d51c8f1bc1b88 Mon Sep 17 00:00:00 2001 From: Julien Eluard Date: Thu, 25 Apr 2024 17:30:11 +0200 Subject: [PATCH 2/2] fix: incorrect paths --- RELEASE.md | 2 +- scripts/prepare-docs.sh | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index b38a4f8562f6..91b450baa34a 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -271,7 +271,7 @@ Historical context and reasons against valid alternatives to help future discuss Lodestar used `master` as the single target for feature branches. -![lodestar-release](docs/images/lodestar-releases.png) +![lodestar-release](docs/static/images/lodestar-releases.png) - Main branch = `master` - Features merged to `master` diff --git a/scripts/prepare-docs.sh b/scripts/prepare-docs.sh index 78b508bf5f29..8b52d7217d45 100755 --- a/scripts/prepare-docs.sh +++ b/scripts/prepare-docs.sh @@ -17,4 +17,3 @@ cp -r packages/prover/README.md $DOCS_DIR/pages/lightclient-prover/prover.md # Copy visual assets rm -rf $DOCS_DIR/pages/assets $DOCS_DIR/pages/images cp -r $ASSETS_DIR $DOCS_DIR/pages/assets -cp -r $DOCS_DIR/images $DOCS_DIR/pages/images