diff --git a/docs/new-docs-structure.md b/docs/new-docs-structure.md new file mode 100644 index 000000000000..6e9e6d766869 --- /dev/null +++ b/docs/new-docs-structure.md @@ -0,0 +1,33 @@ +# Proposal of new docs structure + +- **Overview** +- **Getting Started** _no change_ + - Installation + - Create your first app + - Project Structure (was: Application Layout) +- **Learn** + - Tutorials + - Examples +- **Concepts** + - [Inside a LoopBack Application](https://loopback.io/doc/en/lb4/Inside-LoopBack-Application.html) + (_Discussion: Not sure where it fits best_) +- **How-Tos** +- **CLI Reference** +- **API Reference** +- **Connectors** +- **Extensions** _no change_ + - Build an extension + - Community Extensions +- **Best Practices** _no change_ +- **Contributng** _Add some of the contributing info from LB3_ +- **FAQ** _Discussion: not sure how useful it is to keep it_ +- **References** + - Change logs (_Discussion: Proposed to remove. We have change logs in the + repo already._) + - _some other items here_ +- **Migration Guide** + +--- + +- [Build large scale Node.js projects with LoopBack 4](https://loopback.io/doc/en/lb4/core-tutorial.html) + _Discussion: Not sure where it's best fit. Under how-to?_