Skip to content

Commit dae4bdb

Browse files
committed
fix: propose new docs structure
Signed-off-by: dhmlau <dhmlau@ca.ibm.com>
1 parent f06ab75 commit dae4bdb

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

docs/new-docs-structure.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Proposal of new docs structure
2+
3+
- **Overview**
4+
- **Getting Started** _no change_
5+
- Installation
6+
- Create your first app
7+
- Project Structure (was: Application Layout)
8+
- **Learn**
9+
- Tutorials
10+
- Examples
11+
- **Concepts**
12+
- [Inside a LoopBack Application](https://loopback.io/doc/en/lb4/Inside-LoopBack-Application.html)
13+
(_Discussion: Not sure where it fits best_)
14+
- **How-Tos**
15+
- **CLI Reference**
16+
- **API Reference**
17+
- **Connectors**
18+
- **Extensions** _no change_
19+
- Build an extension
20+
- Community Extensions
21+
- **Best Practices** _no change_
22+
- **Contributng** _Add some of the contributing info from LB3_
23+
- **FAQ** _Discussion: not sure how useful it is to keep it_
24+
- **References**
25+
- Change logs (_Discussion: Proposed to remove. We have change logs in the
26+
repo already._)
27+
- _some other items here_
28+
- **Migration Guide**
29+
30+
---
31+
32+
- [Build large scale Node.js projects with LoopBack 4](https://loopback.io/doc/en/lb4/core-tutorial.html)
33+
_Discussion: Not sure where it's best fit. Under how-to?_

0 commit comments

Comments
 (0)