Welcome to the open source tutorials for G1ANT.Robot. Please review this README file to understand how you can assist in contributing to the G1ANT.Robot tutorials.
Contributing to open source is more than just providing updates, it's also letting us know when there is an issue. You can submit issues with the standard Issues tab on GitHub.
Contributing to the documentation requires a GitHub account and some Markdown knowledge.
Folders are treated as separated courses in the Tutorials. Folder names are used for the titles of courses, so [For Beginners](../For Beginners/) folder will turn into “For Beginners” course title on the website.
Files represent individual lessons within a course. The filenames are sequential numbers determining the lessons order. We start with 010 and use three digits and the increments of 10 for the filenames, so that there is some room left for additional intermediate lessons that might appear in future and could be placed between existing ones without disturbing the whole file structure and the resulting lessons order in the Tutorials.
We use headers in Markdown files to allow navigation in the Tutorials structure. Each lesson’s title is derived from header 1 in the .md file.
In tutorials, we avoid media objects (pictures, videos and so on), because they would affect displaying the content in the G1ANT.Robot panel. Should you want to attach any example file for your tutorials, place it in -assets folder, and link to it as relative path in the .md file, for example ../-assets/data.xslx
.
Folders and files with the “-” prefix are skipped by our sync tool, which gathers together Markdown files from Manual, Tutorials and Addon repositories and creates content to be displayed on the G1ANT.Manual and G1ANT.Learning websites.
Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.
Please refer to LICENSE file for all Licensing information.