Documentation

This page shows documentation items that are available for users to read through. Documentation for H2O and Sparkling Water is added automatically when you upload a new engine. Steam administrators may upload additional custom documentation items.

Documentation screen

Adding Documentation Items

Steam administrators may upload additional custom documentation items using the Add Item button. On this page you three different ways to do so.

General File

To add documentation file, specify a name and use the upload dialog to upload the item. It will be available to all users on the documentation page under the General section. The item will be displayed in browser if possible (image, PDF, …), otherwise it will be downloaded.

Add General documentation item file

General Archive

To add documentation archive, specify a name and use the upload dialog to upload the archive. The archive must a be a ZIP format and you may specify an entrypoint. Entrypoint is a path relative to the root of the archive which will be served to users.

Add General documentation item archive

H2O Archive

This documentation type is used to upload custom H2O documentation. The archive must a be a ZIP format and you may specify an entrypoint. Entrypoint is a path relative to the root of the archive which will be served to users.

Add H2O documentation

Deleting Documentation

Steam administrator may delete a documentation item at any time using the trash icon next to the item. It will no longer be available for users. This action is permanent. To restore the documentation item you must add it again.