Developer guide

A goal-oriented document that gives practical steps for a specific outcome.

• How-to guide
• Erlang/OTP
• Template

• Automatic recompilation and file watching
• Build and serve frontend assets
• Build and serve frontend assets

An information-oriented description of an API component option syntax or behavior.

• Reference

• chrome: Open a site in Chrome
• chromium: Open a site in Chromium
• compilefile: Recompile one Erlang source file

An understanding-oriented document that explains concepts reasons architecture or trade-offs.

• Explanation
• Site
• Module

• Anatomy of a reusable module
• Anatomy of a site application
• Application and module names

A diagnostic document organized around symptoms causes checks and remedies.

• Troubleshooting

• A model returns an error or no value
• A saved change does not appear
• A site does not start

A learning-oriented document that guides a newcomer through a complete experience.

• Tutorial

• Change a template and see the result
• Set up a local development environment