You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+15-10
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Whenever you are submitting any changes to the Generative AI for Beginners repos
30
30
* 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
31
31
* If you are submitting a typo or documentation fix, you can combine modifications to a single PR where suitable
32
32
33
-
## General Guidance for writing
33
+
## General Guidance for writing
34
34
35
35
- Ensure that all your URLs are wrapped in square brackets followed by a parenthesis with no extra spaces around them or inside them `[]()`.
36
36
- 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
42
42
43
43
## GitHub Workflows
44
44
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.
46
46
Simply follow the instructions listed here to pass the workflow checks.
@@ -52,19 +52,23 @@ Simply follow the instructions listed here to pass the workflow checks.
52
52
53
53
### Check Broken Relative Paths
54
54
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.
56
56
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.
57
57
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.
59
59
60
60
For example, when you hover over any link in your files you will be prompted to follow the link by pressing on **ctrl + click**

71
+
68
72
Follow the path by clicking on the desired file or folder and you will be sure that your path is not broken.
69
73
70
74
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
79
83
If it's appended to your relative paths then you will pass this check.

117
122
118
123
To fix this issue, try to open the file path that the workflow highlighted and remove the country locale from the URLs.
0 commit comments