diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe9639c58..62e670d5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ Whenever you are submitting any changes to the Generative AI for Beginners repos * 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 * If you are submitting a typo or documentation fix, you can combine modifications to a single PR where suitable -## General Guidance for writing +## General Guidance for writing - Ensure that all your URLs are wrapped in square brackets followed by a parenthesis with no extra spaces around them or inside them `[]()`. - 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 ## GitHub Workflows -When you submit a pull request, four different workflows will be triggered to validate the previous rules. +When you submit a pull request, four different workflows will be triggered to validate the previous rules. Simply follow the instructions listed here to pass the workflow checks. - [Check Broken Relative Paths](#check-broken-relative-paths) @@ -52,19 +52,23 @@ Simply follow the instructions listed here to pass the workflow checks. ### Check Broken Relative Paths -This workflow ensures that any relative path in your files is working. +This workflow ensures that any relative path in your files is working. 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. -To make sure that your links are working properly simply use VS code to check that. +To make sure that your links are working properly simply use VS code to check that. For example, when you hover over any link in your files you will be prompted to follow the link by pressing on **ctrl + click** -![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/0ba24c75-bc02-448c-9ce1-7c97dc22c98c) + +![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.") + 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. To fix this issue, try to type the link with the help of VS code. When you type `./` or `../` VS code will prompt you to choose from the available options according to what you typed. -![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/792c1bc1-4c3f-4ad4-a8c5-66dcf224f668) + +![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.") + Follow the path by clicking on the desired file or folder and you will be sure that your path is not broken. 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 If it's appended to your relative paths then you will pass this check. If not, you may get the following error. -![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/d5e53a5a-d53d-4486-be80-1a9ed7115093) + +![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") 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. Once you add the tracking ID, save, and push your changes the workflow will be triggered again to verify your changes. If you pass the check then you are good to go. - ### Check URLs Have Tracking 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 If it's appended to your URLs then you will pass this check. If not, you may get the following error. -![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/72d23ee5-180d-453c-a119-6b9011647a45) +![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") 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. @@ -113,7 +117,8 @@ To make sure your URLs don't have country locale in them simply check for the fo If it's not present in your URLs then you will pass this check. If not, you may get the following error. -![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/c261987b-f6eb-484e-a4a3-bab696828d62) + +![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") To fix this issue, try to open the file path that the workflow highlighted and remove the country locale from the URLs. diff --git a/README.md b/README.md index 9d060a1f7..28c6d96fa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -![Generative AI For Beginners](./img/1.png?WT.mc_id=academic-105485-koreyst) +![Generative AI For Beginners](./images/repository-thumbnail.png?WT.mc_id=academic-105485-koreyst) ### A 12 Lesson course teaching everything you need to know to start building Generative AI applications diff --git a/img/android-chrome-192x192.png b/images/android-chrome-192x192.png similarity index 100% rename from img/android-chrome-192x192.png rename to images/android-chrome-192x192.png diff --git a/img/android-chrome-512x512.png b/images/android-chrome-512x512.png similarity index 100% rename from img/android-chrome-512x512.png rename to images/android-chrome-512x512.png diff --git a/img/apple-touch-icon.png b/images/apple-touch-icon.png similarity index 100% rename from img/apple-touch-icon.png rename to images/apple-touch-icon.png diff --git a/img/favicon-16x16.png b/images/favicon-16x16.png similarity index 100% rename from img/favicon-16x16.png rename to images/favicon-16x16.png diff --git a/img/favicon-32x32.png b/images/favicon-32x32.png similarity index 100% rename from img/favicon-32x32.png rename to images/favicon-32x32.png diff --git a/img/favicon.ico b/images/favicon.ico similarity index 100% rename from img/favicon.ico rename to images/favicon.ico diff --git a/images/github-check-country-locale-comment.png b/images/github-check-country-locale-comment.png new file mode 100644 index 000000000..f145d27c0 Binary files /dev/null and b/images/github-check-country-locale-comment.png differ diff --git a/images/github-check-paths-missing-tracking-comment.png b/images/github-check-paths-missing-tracking-comment.png new file mode 100644 index 000000000..a06d110e2 Binary files /dev/null and b/images/github-check-paths-missing-tracking-comment.png differ diff --git a/images/github-check-urls-missing-tracking-comment.png b/images/github-check-urls-missing-tracking-comment.png new file mode 100644 index 000000000..c08391990 Binary files /dev/null and b/images/github-check-urls-missing-tracking-comment.png differ diff --git a/img/logo.png b/images/logo.png similarity index 100% rename from img/logo.png rename to images/logo.png diff --git a/img/1.png b/images/repository-thumbnail.png similarity index 100% rename from img/1.png rename to images/repository-thumbnail.png diff --git a/img/site.webmanifest b/images/site.webmanifest similarity index 100% rename from img/site.webmanifest rename to images/site.webmanifest diff --git a/images/vscode-follow-link.png b/images/vscode-follow-link.png new file mode 100644 index 000000000..32a9c47a8 Binary files /dev/null and b/images/vscode-follow-link.png differ diff --git a/images/vscode-select-relative-path.png b/images/vscode-select-relative-path.png new file mode 100644 index 000000000..165d128da Binary files /dev/null and b/images/vscode-select-relative-path.png differ diff --git a/index.html b/index.html index d0293a6ee..6009dd7c9 100644 --- a/index.html +++ b/index.html @@ -8,10 +8,10 @@ - - - - + + + + diff --git a/translation/cn/README.md b/translation/cn/README.md index c9fc199ad..888a4b8ad 100644 --- a/translation/cn/README.md +++ b/translation/cn/README.md @@ -1,5 +1,5 @@ -![Generative AI For Beginners](../../img/1.png?WT.mc_id=academic-105485-koreyst) +![Generative AI For Beginners](../../images/repository-thumbnail.png?WT.mc_id=academic-105485-koreyst) ### 通过 12 章的课程，开启构建生成式 AI 应用程序之路