docs: draft proposal for docs improvement #3164
Conversation
|
@strongloop/loopback-maintainers, I'd like to get your feedback on how we categorize our docs at a higher level first and the naming. Thanks. |
docs/site/site-proposal.md
Outdated
| - **Getting Started**: no change. [Getting-started.md](Getting-started.md) | ||
| - **Tutorials**: [Tutorials.md](Tutorials.md). | ||
|
|
||
| - **Basic constructs**: Same as |
There was a problem hiding this comment.
maybe keeping Key Concepts
docs/site/site-proposal.md
Outdated
| - Extension point/extension | ||
| - Discovering and ordering | ||
| - Chain of handling | ||
|
|
There was a problem hiding this comment.
At the moment, we have the following sections in Extending LoopBack:
What's the plan - are we going to preserve them unchanged?
From my point of view, I feel it's important to provide good documentation for extension developers, showing them best practices for building npm modules providing reusable functionality for LB4 applications.
There was a problem hiding this comment.
I've added them under "Extending LoopBack". Thanks.
docs/site/site-proposal.md
Outdated
|
|
||
| Question: I have trouble mapping the following contents. Please help: | ||
|
|
||
| - Serving static files ?? |
There was a problem hiding this comment.
This should go under Usage scenario.
docs/site/site-proposal.md
Outdated
| Question: I have trouble mapping the following contents. Please help: | ||
|
|
||
| - Serving static files ?? | ||
| - Self-hosted REST API Explorer -> Under "Extending LoopBack"?- Boot and Mount a |
There was a problem hiding this comment.
This should go under Create APIs.
docs/site/site-proposal.md
Outdated
| - Serving static files ?? | ||
| - Self-hosted REST API Explorer -> Under "Extending LoopBack"?- Boot and Mount a | ||
| LoopBack 3 Application -> Under "For LoopBack 3.x users"? | ||
| - Remove "Crafting LoopBack 4"?? |
There was a problem hiding this comment.
We can have an Architecture section, including Behind the scene
There was a problem hiding this comment.
I've renamed the behind the scene to architecture now.
|
Closing this PR as some has turned into GH issues, and another round of improvement is led by Miroslav. |
Based on @raymondfeng's draft #2925, the purpose of this PR is to create a concrete plan on what we should do at a high level and for each section.
The goal is that we can create smaller tasks out of this proposal.