Skip to content

Commit 5eefbce

Browse files
committed
tidy images
1 parent f2e714e commit 5eefbce

18 files changed

+21
-16
lines changed

CONTRIBUTING.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Whenever you are submitting any changes to the Generative AI for Beginners repos
3030
* If you are submitting a translation, please create one PR for all the translated files as we don't accept partial translations for the content
3131
* If you are submitting a typo or documentation fix, you can combine modifications to a single PR where suitable
3232

33-
## General Guidance for writing
33+
## General Guidance for writing
3434

3535
- Ensure that all your URLs are wrapped in square brackets followed by a parenthesis with no extra spaces around them or inside them `[]()`.
3636
- Ensure that any relative link (i.e. links to other files and folders in the repository) starts with a `./` referring to a file or a folder located in the current working directory or a `../` referring to a file or a folder located in a parent working directory.
@@ -42,7 +42,7 @@ Whenever you are submitting any changes to the Generative AI for Beginners repos
4242

4343
## GitHub Workflows
4444

45-
When you submit a pull request, four different workflows will be triggered to validate the previous rules.
45+
When you submit a pull request, four different workflows will be triggered to validate the previous rules.
4646
Simply follow the instructions listed here to pass the workflow checks.
4747

4848
- [Check Broken Relative Paths](#check-broken-relative-paths)
@@ -52,19 +52,23 @@ Simply follow the instructions listed here to pass the workflow checks.
5252

5353
### Check Broken Relative Paths
5454

55-
This workflow ensures that any relative path in your files is working.
55+
This workflow ensures that any relative path in your files is working.
5656
This repository is deployed to GitHub pages so you need to be very careful when you type the links that glue everything together to not direct anyone to the wrong place.
5757

58-
To make sure that your links are working properly simply use VS code to check that.
58+
To make sure that your links are working properly simply use VS code to check that.
5959

6060
For example, when you hover over any link in your files you will be prompted to follow the link by pressing on **ctrl + click**
61-
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/0ba24c75-bc02-448c-9ce1-7c97dc22c98c)
61+
62+
![VS code follow links screenshot](./images/vscode-follow-link.png "Screenshot from vs code prompt to follow a link when you hover over a link.")
63+
6264
If you click on a link and it's not working locally then, surely it will trigger the workflow and won't work on GitHub.
6365

6466
To fix this issue, try to type the link with the help of VS code.
6567

6668
When you type `./` or `../` VS code will prompt you to choose from the available options according to what you typed.
67-
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/792c1bc1-4c3f-4ad4-a8c5-66dcf224f668)
69+
70+
![VS code select relative path screenshot](./images/vscode-select-relative-path.png "Screenshot from vs code prompt to select relative path from a pop up list.")
71+
6872
Follow the path by clicking on the desired file or folder and you will be sure that your path is not broken.
6973

7074
Once you add the correct relative path, save, and push your changes the workflow will be triggered again to verify your changes.
@@ -79,14 +83,14 @@ To make sure your relative paths have tracking in them simply check for the foll
7983
If it's appended to your relative paths then you will pass this check.
8084

8185
If not, you may get the following error.
82-
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/d5e53a5a-d53d-4486-be80-1a9ed7115093)
86+
87+
![GitHub check paths missing tracking comment screenshot](./images/github-check-paths-missing-tracking-comment.png "Screenshot from github comment that shows missing tracking from relative paths")
8388

8489
To fix this issue, try to open the file path that the workflow highlighted and add the tracking ID to the end of the relative paths.
8590

8691
Once you add the tracking ID, save, and push your changes the workflow will be triggered again to verify your changes.
8792
If you pass the check then you are good to go.
8893

89-
9094
### Check URLs Have Tracking
9195

9296
This workflow ensures that any web URL has tracking in it.
@@ -96,8 +100,8 @@ To make sure your URLs have tracking in them simply check for the following text
96100
If it's appended to your URLs then you will pass this check.
97101

98102
If not, you may get the following error.
99-
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/72d23ee5-180d-453c-a119-6b9011647a45)
100103

104+
![GitHub check urls missing tracking comment screenshot](./images/github-check-urls-missing-tracking-comment.png "Screenshot from github comment that shows missing tracking from urls")
101105

102106
To fix this issue, try to open the file path that the workflow highlighted and add the tracking ID to the end of the URLs.
103107

@@ -113,7 +117,8 @@ To make sure your URLs don't have country locale in them simply check for the fo
113117
If it's not present in your URLs then you will pass this check.
114118

115119
If not, you may get the following error.
116-
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/c261987b-f6eb-484e-a4a3-bab696828d62)
120+
121+
![GitHub check country locale comment screenshot](./images/github-check-urls-missing-tracking-comment.png "Screenshot from github comment that shows added country locale to urls")
117122

118123
To fix this issue, try to open the file path that the workflow highlighted and remove the country locale from the URLs.
119124

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
![Generative AI For Beginners](./img/1.png?WT.mc_id=academic-105485-koreyst)
2+
![Generative AI For Beginners](./images/repository-thumbnail.png?WT.mc_id=academic-105485-koreyst)
33

44
### A 12 Lesson course teaching everything you need to know to start building Generative AI applications
55

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

img/favicon.ico images/favicon.ico

File renamed without changes.
97.7 KB
Loading
Loading
Loading

img/logo.png images/logo.png

File renamed without changes.
File renamed without changes.
File renamed without changes.

images/vscode-follow-link.png

120 KB
Loading
164 KB
Loading

index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
<meta name="description" content="Description">
99
<meta name="viewport"
1010
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
11-
<link rel="apple-touch-icon" sizes="180x180" href="img/apple-touch-icon.png">
12-
<link rel="icon" type="image/png" sizes="32x32" href="img/favicon-32x32.png">
13-
<link rel="icon" type="image/png" sizes="16x16" href="img/favicon-16x16.png">
14-
<link rel="manifest" href="img/site.webmanifest">
11+
<link rel="apple-touch-icon" sizes="180x180" href="images/apple-touch-icon.png">
12+
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png">
13+
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png">
14+
<link rel="manifest" href="images/site.webmanifest">
1515
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
1616
</head>
1717

translation/cn/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
![Generative AI For Beginners](../../img/1.png?WT.mc_id=academic-105485-koreyst)
2+
![Generative AI For Beginners](../../images/repository-thumbnail.png?WT.mc_id=academic-105485-koreyst)
33

44
### 通过 12 章的课程,开启构建生成式 AI 应用程序之路
55

0 commit comments

Comments
 (0)