Skip to content

annaesvensson/yellow-help

Repository files navigation

Help 0.9.9

Documentation of the basics. Developed by Anna Svensson.

Screenshot

How to install an extension

Download ZIP file and copy it into your system/extensions folder. Learn more about extensions.

How to use the help

The help is available on your website as http://website/help/. The help shows you how to make small websites, wikis and blogs. Here you will find instructions on how to customise your website in English, German and Swedish. For developers there are descriptions of files, folders and what can be done with the API. It's recommended to install the highlight extension, search extension, toc extension together with the help extension. Then you will have the same package as the help on the official website.

How to improve the help

You can improve the help if something is wrong or missing. Install the help on your website, then you can make some changes and review the help from the perspective of the user. If you want to edit the help in a web browser, you can do this on your website at http://website/edit/help/. If you want to edit the help on your computer, have a look inside your content/9-help folder. For experienced writers there's a style guide. Did you improve the help? Fork this repository. Upload your changes and create a pull request for the repository annaesvensson/yellow-help.

How to improve documentation

You can find basic documentation in the help and more detailed documentation in extensions. Typically the documentation of an extension consists of multiple sections, with examples to copy/paste and settings you can customise. Review the entire documentation from the perspective of the user. Imagine what the user wants to do and what would make their life easier. For experienced writers there's a style guide. Did you improve documentation? Fork the relevant repository. Upload your changes and send a pull request to the developer.

Acknowledgements

This extension includes a photo by Bruno Cervera. Thank you for the beautiful photo.

Do you have questions? Get help.

About

Documentation of the basics.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages