Skip to content

[RFC] propose new docs structure #11635

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.

Sign up for GitHub

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

Draft
dhmlau wants to merge 1 commit into
base: master
Choose a base branch
from
+33 −0
Draft

[RFC] propose new docs structure #11635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 33 additions & 0 deletions docs/new-docs-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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?_