Writing Documentation
You would like to contribute to the wolkenkit documentation? Great, here you will find tips and components you can use to create great documentation that will empower developers.
Paragraphs
Use the Paragraph
component for formatting texts. Be short and precise. Be kind and try to put yourself in the shoes of the application developer that does not.
Code samples
language: javascript
const greeting = 'Hello world';
language: typescript
const greeting: string = 'Hello world';
language: shell
$ cd my-wolkenkit-sample-application
Hints
type: congrats
Congratulations! It's motivating to hear kind words when mastering a tricky task. Use type of hint, if you would like to reward the learner.
type: question
Do you think this makes sense? Use this type…
type: free
A tip for free Use this type…
type: warning
A word of warning Use this type…
type: wisdom
This is something to remember Use this type…