@loopback/docs/README.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

# LoopBack 4 documentation

This package contains documentation for LoopBack 4. It's published to npm as
[@loopback/docs](https://www.npmjs.com/package/@loopback/docs).

## Documentation site

The `site` directory contains pages for
http://loopback.io/doc/en/lb4/index.html.

To contribute, please check out
https://loopback.io/doc/en/contrib/doc-contrib.html.

We are using the documentation system based on four quadrants, as described at
https://documentation.divio.com

- Learning-oriented [Tutorials](https://documentation.divio.com/tutorials/),
  nested in [Tutorials](./site/Tutorials.md) section of the sidebar.

- Problem-oriented
  [How-to Guides](https://documentation.divio.com/how-to-guides/), nested in
  [Usage scenarios](./site/Usage-scenarios.md) section of the sidebar.

- Understanding-oriented
  [Explanation](https://documentation.divio.com/explanation/), nested in
  [Behind the scenes](./site/Behind-the-scene.md) section of the sidebar.

- Information-oriented
  [Reference guides](https://documentation.divio.com/reference/), nested in
  [Reference guides](./site/Reference.md) section of the sidebar.

## API references

The API docs are generated by running `npm run tsdocs` at the root directory of
[loopback-next](https://github.com/strongloop/loopback-next). The task is run as
part of the release process. Official
[API references](https://loopback.io/doc/en/lb4/apidocs.index.html) is served
from [loopback.io](https://www.loopback.io) web site.