Luigi documentation refinements #80
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
requested review from
kazydek,
klaudiagrz and
tomekpapiernik
as code owners
kwiatekus
approved these changes
Sep 14, 2018
klaudiagrz
reviewed
Sep 14, 2018
README.md
Outdated
| - [General settings](docs/general-settings.md) | ||
| Luigi core is the part of Luigi that enables navigation, security and routing. To get started with Luigi, read [this](docs/application-setup.md) document. | ||
|
|
||
| - [Application setup](docs/application-setup.md) - Shows you the first steps to prepare your application for development. |
There was a problem hiding this comment.
Make the full sentences out of those bullet points (with no "-"), such as:
- [Application setup](docs/application-setup.md) shows you the first steps to prepare your application for development.
...
README.md
Outdated
| - [UX Manager](docs/ux-manager.md) | ||
| ### Luigi client | ||
|
|
||
| Luigi client enables integration of Luigi in views. Configure the lifecycle and links of the client. Customize the appearance of Luigi client. |
There was a problem hiding this comment.
of the Luigi client. ???
docs/application-setup.md
Outdated
| @@ -2,6 +2,13 @@ | |||
|
|
|||
| Prior to the implementation of Luigi, you need to set up your application. This document shows you how to set up a web application using the Luigi micro front-end framework. | |||
|
|
|||
| Choose the framework used to build your application: | |||
klaudiagrz
reviewed
Sep 14, 2018
README.md
Outdated
|
|
||
| ## Development | ||
| - [Lifecycle](docs/lifecycle.md) - Gives you details on the life cycle of listeners, navigation nodes and event data. |
There was a problem hiding this comment.
Make the full sentences out of those bullet points (with no "-")
klaudiagrz
reviewed
Sep 14, 2018
README.md
Outdated
| - [UX Manager](docs/ux-manager.md) | ||
| ### Luigi client | ||
|
|
||
| Luigi client enables integration of Luigi in views. Configure the lifecycle and links of the client. Customize the appearance of your navigation. |
There was a problem hiding this comment.
You can easily configure the lifecycle and links of the client, as well as customize the appearance of your navigation.
README.md
Outdated
|
|
||
| ## Development | ||
| - [Lifecycle](docs/lifecycle.md) gives you details on the life cycle of listeners, navigation nodes and event data. |
klaudiagrz
approved these changes
Sep 14, 2018
ghost
mentioned this pull request
stanleychh
pushed a commit
to stanleychh/luigi
that referenced
this pull request
Dec 30, 2021
* Documentation refinements including sentence formatting, rewording and capitalization.
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Related issue(s)