Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move docs assets to a separate directory #83

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Move docs assets to a separate directory #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/src/color-issue1.png → docs/src/assets/color-issue1.png
View file
Open in desktop
File renamed without changes
0 docs/src/color-issue2.png → docs/src/assets/color-issue2.png
View file
Open in desktop
File renamed without changes
0 docs/src/devmode.png → docs/src/assets/devmode.png
View file
Open in desktop
File renamed without changes
0 docs/src/help.png → docs/src/assets/help.png
View file
Open in desktop
File renamed without changes
0 docs/src/kiss.gif → docs/src/assets/kiss.gif
View file
Open in desktop
File renamed without changes
0 docs/src/normal-colors.png → docs/src/assets/normal-colors.png
View file
Open in desktop
File renamed without changes
0 docs/src/pr.png → docs/src/assets/pr.png
View file
Open in desktop
File renamed without changes
0 docs/src/truecolor.png → docs/src/assets/truecolor.png
View file
Open in desktop
File renamed without changes
0 docs/src/type-checking.png → docs/src/assets/type-checking.png
View file
Open in desktop
File renamed without changes
8 changes: 4 additions & 4 deletions docs/src/color-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/src/creating-a-pull-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/presentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/project-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/src/recommended-ide-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down