Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): explain how is the content organized #5941

Merged
merged 1 commit into from
Jul 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 7 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,15 @@ This package contains documentation for LoopBack 4. It's published to npm as

## Documentation site

The `site` directory contains pages for
http://loopback.io/doc/en/lb4/index.html.
The `site` directory contains pages for documentation published at
[loopback.io](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.
The content is organized along four quadrants as explained in
[How is our documentation organized](./site/index.md#how-is-our-documentation-organized).

- 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.
To contribute, please check out
[Contributing to LoopBack documentation](https://loopback.io/doc/en/contrib/doc-contrib.html)
and [Developing Documentation](./site/DEVELOPING.md#documentation).

## API references

Expand Down
25 changes: 22 additions & 3 deletions docs/site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ will be in separate repositories.

{% include important.html content="Certain features from LoopBack 3 may still be a work in progress or are not planned to be migrated to LoopBack 4. See [Understanding the differences](Understanding-the-differences.md)." %}

## Overview

LoopBack is a highly extensible, open-source Node.js and TypeScript framework
based on Express that enables you to quickly create APIs and microservices
composed from backend systems such as databases and SOAP or REST services.
Expand All @@ -27,7 +29,7 @@ personas who are interested in various capabilities provided by LoopBack.

![LoopBack 4 Overview](./imgs/lb4-high-level.png)

## Built for API developers
### Built for API developers

- Define your API endpoints and schemas using the
[OpenAPI](https://www.openapis.org/) standard.
Expand All @@ -36,16 +38,33 @@ personas who are interested in various capabilities provided by LoopBack.
- Use your defined endpoints and schemas as the source of truth without
generating code.

## Built for teams
### Built for teams

- Review changes to API endpoints without digging through JavaScript.
- Maintain consistency by automating the validation of your endpoints and
schemas.
- First class support for [TypeScript](https://www.typescriptlang.org) (strongly
typed JavaScript).

## Built for your platform
### Built for your platform

- Use LoopBack as a starting point for your own framework or platform.
- Build libraries of reusable components in a standardized way.
- Integrate with databases, web services, and other platforms using connectors.

## How is our documentation organized

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

- Learning-oriented `Tutorials` provide hands-on lessons where users can learn
the framework by doing.

- Problem-oriented `How-to Guides` provide recipes to solve specific goals you
may encounter while building a LoopBack project.

- Understanding-oriented `Behind the scenes` pages provide background and
context, wider view and deeper knowledge about the framework.

- Information-oriented `Reference guides` provide technical description of the
machinery and how to use it.