Getting Started

The following technical documentation describes how to build angular frontend applications . It includes a set of best practices and guidelines you can follow. It is inspired by the work I have done for PlanB GmbH and the knowledge I have learned over the past 5 years.

In order to structure our documentation we are using the Diátaxis Framework

Tutorials

Tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind. Tutorials are learning-oriented.

How-To Guides

How-to guides are directions that take the reader through the steps required to solve a real-world problem. How-to guides are goal-oriented.

Technical Reference

Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented.

Explanation

Explanation is discussion that clarifies and illuminates a particular topic. Explanation is understanding-oriented.