docs: updated interactive shell

lmorg · Jun 26, 2024 · 954838f · 954838f
1 parent 5a8d91e
commit 954838f
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/.github/workflows/deploy-dev-docs.yaml b/.github/workflows/deploy-dev-docs.yaml
@@ -93,6 +93,6 @@ jobs:
  AWS_DEFAULT_REGION: eu-west-1
  AWS_DEFAULT_OUTPUT: json
  run: |
- aws s3 sync docs/.vuepress/dist s3:https://murex.rocks/develop --exclude "*.md" --no-progress
+ aws s3 sync docs/.vuepress/dist s3:https://murex.rocks/develop --exclude "*.md" --no-progress --delete
  aws cloudfront create-invalidation --distribution-id "${{ secrets.CLOUDFRONT_DISTRIBUTION_ID_DEV }}" --paths "/*"
  
diff --git a/docs/integrations/kitty.md b/docs/integrations/kitty.md
@@ -18,7 +18,7 @@ terminal. Normally that would be a blocky "pixellated" representation using
 block characters. But if you're running Kitty, Murex will automatically switch
 to Kitty's ANSI escape sequences to render those images beautifully.
 
-![opening an image in Kitty](https://nojs.murex/rocks/images/screenshot-kitty-open.png)
+![opening an image in Kitty](https://nojs.murex.rocks/images/screenshot-kitty-open.png)
 
 ## See Also
 

diff --git a/docs/integrations/terminology.md b/docs/integrations/terminology.md
@@ -19,7 +19,7 @@ block characters. But if you're running Terminology, Murex will automatically
 switch to Terminology's ANSI escape sequences to render those images
 beautifully.
 
-![opening an image in Kitty](https://nojs.murex/rocks/images/screenshot-terminology-open.png)
+![opening an image in Kitty](https://nojs.murex.rocks/images/screenshot-terminology-open.png)
 
 ## See Also
 

diff --git a/gen/user-guide/interactive-shell.inc.md b/gen/user-guide/interactive-shell.inc.md
@@ -91,7 +91,10 @@ method define jq {
 {{ if env "DOCGEN_TARGET=vuepress" }}
 <!-- markdownlint-disable -->
 <br/>
-<img src="/screenshot-ps-select.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+<figure>
+ <img src="/screenshot-ps-select.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+ <figcaption>Context aware data-types without reinventing coreutils</figcaption>
+</figure>
 <!-- markdownlint-restore -->
 {{ end }}
 
@@ -123,7 +126,10 @@ for more details.
 
 {{ if env "DOCGEN_TARGET=vuepress" }}
 <!-- markdownlint-disable -->
-<img src="/screenshot-spellchecker.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+<figure>
+ <img src="/screenshot-spellchecker.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+ <figcaption>Inline spellchecking</figcaption>
+</figure>
 <!-- markdownlint-restore -->
 {{ end }}
 
@@ -179,7 +185,10 @@ complex documents like machine generated JSON becomes very easy.
 
 {{ if env "DOCGEN_TARGET=vuepress" }}
 <!-- markdownlint-disable -->
-<img src="/screenshot-preview-command-line.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+<figure>
+ <img src="/screenshot-preview-command-line.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+ <figcaption>Command line preview allows a faster way to iterate over a command line logic</figcaption>
+</figure>
 <!-- markdownlint-restore -->
 {{ end }}
 
@@ -218,7 +227,10 @@ about to execute.
 
 {{ if env "DOCGEN_TARGET=vuepress" }}
 <!-- markdownlint-disable -->
-<img src="/screenshot-paste-safety.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+<figure>
+ <img src="/screenshot-paste-safety.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+ <figcaption>Murex presets a menu to double check what you're pasting before the shell executes it</figcaption>
+</figure>
 <!-- markdownlint-restore -->
 {{ end }}
 
@@ -232,6 +244,10 @@ give you as much useful detail as it can.
 
 {{ if env "DOCGEN_TARGET=vuepress" }}
 <!-- markdownlint-disable -->
-<img src="/screenshot-error-messages.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+<figure>
+ <img src="/screenshot-error-messages.png?v={{ env "COMMITHASHSHORT" }}" class="centre-image"/>
+ <figcaption>Meaningful error messages</figcaption>
+</figure>
+
 <!-- markdownlint-restore -->
 {{ end }}