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: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -24,33 +24,33 @@ More DS tools [here](https://github.com/SymDSTools)
24
24
25
25
## Structure
26
26
27
-
-**docs:** The latest generated documentation for the Github Pages preview
27
+
-**docs:** The latest generated documentation for the GitHub Pages preview
28
28
-**files:** docs source files and generation scripts
29
29
30
-
The docs sources are written in a custom [markup format](files/markdown/README.md). For legacy reasons those markup files will be converted into an intermediate [JSON Format](files/json/README.md) which will then be converted to the html docs you all know and love.
30
+
The docs sources are written in a custom [markup format](files/markup/README.md). For legacy reasons those markup files will be converted into an intermediate [JSON Format](files/json/README.md) which will then be converted to the HTML docs you all know and love.
31
31
32
32
## For Contributors:
33
33
34
-
To contribute to the Docs you need to have an active GitHub account. [Sign up](https://github.com/signup?source_repo=DroidScript%2FDocs) if you dont have one.
34
+
To contribute to the Docs you need to have an active GitHub account. [Sign up](https://github.com/signup?source_repo=DroidScript%2FDocs) if you don't have one.
35
35
36
36
### Fork the DroidScript Repository
37
37
To edit the Docs you need to 'fork' the DroidScript repository. The easiest way is to open up a new Codespace on the DroidScript repository.
When the Codespace is open navigate to the files/markup/en directory and make changes on any file you want to contribute. DroidScript has multiple scopes each having its own subdirectory with every possible method defined as _markup.js_ file. Inside you can modify the description, subfunctions, parameters and more. Make sure to follow the [markup format](files/markdown/README.md)!
42
+
When the Codespace is open, navigate to the files/markup/en directory and make changes on any file you want to contribute. DroidScript has multiple scopes each having its own subdirectory with every possible method defined as _markup.js_ file. Inside you can modify the description, subfunctions, parameters and more. Make sure to follow the [markup format](files/markup/README.md)!
43
43
44
44
### Commit Changes
45
45
When you finished your changes switch to the git tab on the left and descibe briefly what you have changed in the commit message field. The first line should describe what you did in general and each following line should include a more detailed list of your changes.\
46
-
After that commit and synchronize your changes to github with the green button below. If you just opened the Codespace on the DroidScript repository it will ask to create a fork.
46
+
After that commit and synchronize your changes to GitHub with the green button below. If you just opened the Codespace on the DroidScript repository it will ask to create a fork.
47
47
48
48
**Note:** there is an ongoing Codespace bug that prevents you from committing to your fork. If that applies to you, open your workspace terminal and execute `git push --set-upstream origin master`
When you are satisfied with your changes and want us to review your changes, go on to the github tab on the left and hit the small 'Create Pull Request' Button that appears on the 'Pull Requests' dropdown menu. This will open a new 'Pull Request' tab where you can provide a description of your changes across all commits you made. You can also review all your commits and changed files. After that hit the green 'Create' button.
53
+
When you are satisfied with your changes and want us to review your changes, go on to the GitHub tab on the left and hit the small 'Create Pull Request' Button that appears on the 'Pull Requests' dropdown menu. This will open a new 'Pull Request' tab where you can provide a description of your changes across all commits you made. You can also review all your commits and changed files. After that hit the green 'Create' button.
0 commit comments