Documenting an Example

You created a useful example and think others might be interested in it. Also, you have forked the examples repository, cloned it, and added your project. Good! Now it's time to document what you have done.

Go to your local repository directory. You will find a folder named example_template. Copy its contents into your project.

This should contain the following directory and files:

• images
• .gitignore
• index.html
• metadata.json

The index.html file is the place where you document your project. Open it in an HTML or text editor of your choice – it should turn out to be basically self-explanatory. Your example's title needs to go in two places, which are marked in the HTML file: the <title> element and the <h1> element. You are not meant to use more than one <h1> element, so please only use headings like <h2>, <h3> etc. on deeper-nested levels. Your title should be crisp and unique inside of the examples repository. It's the one that's displayed in the example wizard and should tell people what they can expect from your example.

Following the title, you can write some stuff about your project, whatever you want. Make sure to use the given template for images. Put your images into the images folder. You should at least have a screenshot of your statechart (which can be created with YAKINDU Statechart Tools itself, just right click in your statechart). You can of course use more images, like detailed parts. Especially when you use YAKINDU Statechart Tools to create software that runs on embedded hardware, a photo of your setup would be nice. If it suits your needs, you are allowed to link to a video on YouTube in your index.html file. Other streaming platforms are not allowed.

The next step is to write the neccessary metadata for your example. After that, you are ready to publish.