From 66b685035bbdeaf5645c7ca37576189d215adbdb Mon Sep 17 00:00:00 2001 From: SkwalExe Date: Wed, 7 Aug 2024 17:44:45 +0200 Subject: [PATCH] Move docs assets to a separate directory --- docs/src/{ => assets}/color-issue1.png | Bin docs/src/{ => assets}/color-issue2.png | Bin docs/src/{ => assets}/devmode.png | Bin docs/src/{ => assets}/help.png | Bin docs/src/{ => assets}/kiss.gif | Bin docs/src/{ => assets}/normal-colors.png | Bin docs/src/{ => assets}/pr.png | Bin docs/src/{ => assets}/truecolor.png | Bin docs/src/{ => assets}/type-checking.png | Bin docs/src/color-issues.md | 8 ++++---- docs/src/creating-a-pull-request.md | 4 ++-- docs/src/presentation.md | 2 +- docs/src/project-setup.md | 2 +- docs/src/recommended-ide-setup.md | 2 +- 14 files changed, 9 insertions(+), 9 deletions(-) rename docs/src/{ => assets}/color-issue1.png (100%) rename docs/src/{ => assets}/color-issue2.png (100%) rename docs/src/{ => assets}/devmode.png (100%) rename docs/src/{ => assets}/help.png (100%) rename docs/src/{ => assets}/kiss.gif (100%) rename docs/src/{ => assets}/normal-colors.png (100%) rename docs/src/{ => assets}/pr.png (100%) rename docs/src/{ => assets}/truecolor.png (100%) rename docs/src/{ => assets}/type-checking.png (100%) diff --git a/docs/src/color-issue1.png b/docs/src/assets/color-issue1.png similarity index 100% rename from docs/src/color-issue1.png rename to docs/src/assets/color-issue1.png diff --git a/docs/src/color-issue2.png b/docs/src/assets/color-issue2.png similarity index 100% rename from docs/src/color-issue2.png rename to docs/src/assets/color-issue2.png diff --git a/docs/src/devmode.png b/docs/src/assets/devmode.png similarity index 100% rename from docs/src/devmode.png rename to docs/src/assets/devmode.png diff --git a/docs/src/help.png b/docs/src/assets/help.png similarity index 100% rename from docs/src/help.png rename to docs/src/assets/help.png diff --git a/docs/src/kiss.gif b/docs/src/assets/kiss.gif similarity index 100% rename from docs/src/kiss.gif rename to docs/src/assets/kiss.gif diff --git a/docs/src/normal-colors.png b/docs/src/assets/normal-colors.png similarity index 100% rename from docs/src/normal-colors.png rename to docs/src/assets/normal-colors.png diff --git a/docs/src/pr.png b/docs/src/assets/pr.png similarity index 100% rename from docs/src/pr.png rename to docs/src/assets/pr.png diff --git a/docs/src/truecolor.png b/docs/src/assets/truecolor.png similarity index 100% rename from docs/src/truecolor.png rename to docs/src/assets/truecolor.png diff --git a/docs/src/type-checking.png b/docs/src/assets/type-checking.png similarity index 100% rename from docs/src/type-checking.png rename to docs/src/assets/type-checking.png diff --git a/docs/src/color-issues.md b/docs/src/color-issues.md index fea4a38..cc6d8f6 100644 --- a/docs/src/color-issues.md +++ b/docs/src/color-issues.md @@ -2,15 +2,15 @@ **In good conditions, the app should use 24-bit colors which looks like this:** -![Normal colors](./normal-colors.png) +![Normal colors](./assets/normal-colors.png) However, it is possible that when you open the app, the colors are not displaying correctly. In this case, it can look something like this if only 4-bits ANSI colors are used: -![Color issue 1](./color-issue1.png) +![Color issue 1](./assets/color-issue1.png) It can also look like this if only 8-bits ANSI colors are used : -![Color issue 2](./color-issue2.png) +![Color issue 2](./assets/color-issue2.png) If the colors are not displaying correctly, ensure that your terminal supports 24-bit colors (truecolor). You can verify this by copying and pasting the following command into your terminal: @@ -24,7 +24,7 @@ curl -sLo- https://raw.githubusercontent.com/SkwalExe/fractalistic/main/test-tru You should see smooth output similar to the screenshot below. If not, consider updating your terminal or switching to a more modern terminal that supports 24-bit colors. -![Preview](./truecolor.png) +![Preview](./assets/truecolor.png) If your terminal supports 24-bit colors but the colors are still not displaying correctly, you might need to set the following environment variable when running the app: diff --git a/docs/src/creating-a-pull-request.md b/docs/src/creating-a-pull-request.md index 0556f42..bfaf7cd 100644 --- a/docs/src/creating-a-pull-request.md +++ b/docs/src/creating-a-pull-request.md @@ -26,8 +26,8 @@ git push origin main And finally, from your fork's repository, you can now open a new pull request. I should receive a notification and I will review your changes! -![Creating a pull request](./pr.png) +![Creating a pull request](./assets/pr.png) #### **Thank you for making it this far—your contribution means the world to me, and I can't express how happy it makes me. If you're just reading the documentation and haven't contributed yet, thank you for your interest in this project. 🩷** -![Kiss!!](./kiss.gif) +![Kiss!!](./assets/kiss.gif) diff --git a/docs/src/presentation.md b/docs/src/presentation.md index 3112803..3d44589 100644 --- a/docs/src/presentation.md +++ b/docs/src/presentation.md @@ -30,4 +30,4 @@ The command input feature enables you to interact with the application, allowing Details on how to use the command system will be provided in a later section. If you are curious, you can run the `help` or `help +` commands to get an overview of the available commands! -![help command](./help.png) +![help command](./assets/help.png) diff --git a/docs/src/project-setup.md b/docs/src/project-setup.md index 957a573..2d379d3 100644 --- a/docs/src/project-setup.md +++ b/docs/src/project-setup.md @@ -36,4 +36,4 @@ This will open the app in **dev mode**, allowing you to log messages to the **Textual console** (first terminal). To log messages within the code, you must use the `textual.log()` function, and import it if needed. (`from textual import log`) -![Dev mode preview](./devmode.png) +![Dev mode preview](./assets/devmode.png) diff --git a/docs/src/recommended-ide-setup.md b/docs/src/recommended-ide-setup.md index b2d6e89..c958d07 100644 --- a/docs/src/recommended-ide-setup.md +++ b/docs/src/recommended-ide-setup.md @@ -3,7 +3,7 @@ Writing code is good, but writing code with the assistance of autocomplete, autoformatting, error notifications, and linting is even better. ✨ -![Example of type checking integration](./type-checking.png) +![Example of type checking integration](./assets/type-checking.png) You are not required to use the tools mentioned below in your IDE. However, keep in mind that once you finish your changes,