You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should move API reference material from markdown files in site/docs folder to tsdoc comments in the source code.
This story is a part of #5113 Documentation improvements 2020Q3.
The page "Model" contains reference-like content for model/property metadata mixed with guide-like content. We should rework the content into proper guides (recipes for achieving specific outcomes) and move reference description of different metadata options into tsdocs.
The page "Interceptors" contains reference-like content with code snippets showing the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
The page "Life cycle" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
The pages grouped under Decorators are reference guides. Let's move their content into tsdocs and update "Decorators" page to act as a sign post linking to the API docs. For each page we have now, create a section in "Decorators" page and list the relevant decorators there.
The page "Context" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should move API reference material from markdown files in
site/docs
folder to tsdoc comments in the source code.This story is a part of #5113 Documentation improvements 2020Q3.
Acceptance criteria
List of places to modify:
https://loopback.io/doc/en/lb4/Server.html#rest-options
The page "Model" contains reference-like content for model/property metadata mixed with guide-like content. We should rework the content into proper guides (recipes for achieving specific outcomes) and move reference description of different metadata options into tsdocs.
http://loopback.io/doc/en/lb4/Creating-crud-rest-apis.html#model-configuration-options
https://loopback.io/doc/en/lb4/Using-database-transactions.html#isolation-levels
The page "Interceptors" contains reference-like content with code snippets showing the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
The page "Life cycle" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
export type LifeCycleObserverOptions
)The pages grouped under Decorators are reference guides. Let's move their content into tsdocs and update "Decorators" page to act as a sign post linking to the API docs. For each page we have now, create a section in "Decorators" page and list the relevant decorators there.
The page "Context" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
https://loopback.io/doc/en/lb4/Binding.html#binding-events
https://loopback.io/doc/en/lb4/Dependency-injection.html#additional-inject-or-sugar-decorators -- leverage the new "Decorators" page
The text was updated successfully, but these errors were encountered: