Modernize docs #108
Open
Modernize docs #108
Conversation
This file contains hidden or 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
example code updated to reflect latest Auro element APIs example documentation layout improved custom registration updated and moved to install page properties now listed alphabetically doc build system now uses the latest version of auro-cli package json configuration updated to support latest auro-cli additional packages dependencies updated to latest versions
Reviewer's GuideModernizes documentation, examples, and project metadata for the auro-flightline component while improving API docs, adding custom element metadata, and updating tooling and GitHub settings. Sequence diagram for custom registration and usage of AuroFlightline componentssequenceDiagram
actor Developer
participant AppModule
participant AuroFlightlineClass as AuroFlightline
participant AuroFlightSegmentClass as AuroFlightSegment
participant Browser
participant HTMLPage
Developer->>AppModule: Write import statements
AppModule->>AuroFlightlineClass: import AuroFlightline from module
AppModule->>AuroFlightSegmentClass: import AuroFlightSegment from module
Developer->>AppModule: Configure custom tag names
AppModule->>AuroFlightlineClass: register("custom-flightline")
AuroFlightlineClass->>Browser: define custom element custom-flightline
AppModule->>AuroFlightSegmentClass: register("custom-flight-segment")
AuroFlightSegmentClass->>Browser: define custom element custom-flight-segment
Developer->>HTMLPage: Use <custom-flightline> with <custom-flight-segment>
HTMLPage->>Browser: Parse custom-flightline markup
Browser->>AuroFlightlineClass: Construct custom-flightline instance
AuroFlightlineClass->>AuroFlightlineClass: _initializeDefaults()
Browser->>AuroFlightSegmentClass: Construct child custom-flight-segment
AuroFlightSegmentClass->>AuroFlightSegmentClass: _initializeDefaults()
Browser->>HTMLPage: Render flightline UI with segments
Updated class diagram for AuroFlightline and AuroFlightSegment componentsclassDiagram
class AuroFlightline {
<<customElement>>
+Boolean canceled
+Boolean firstSegmentCanceled
+Boolean hasCanceledSegment
+Boolean lastSegmentCanceled
+_initializeDefaults()
+render()
+static styles
+static properties
+static register(name)
}
class AuroFlightSegment {
<<customElement>>
+Boolean canceled
+Boolean destinationCanceled
+String duration
+String iata
+Boolean nextDay
+Boolean partialCancel
+Boolean stopover
+_initializeDefaults()
+render()
+static styles
+static properties
+static register(name)
}
AuroFlightline "1" o-- "many" AuroFlightSegment : contains
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- In
AuroFlightSegment.registerthe JSDoc@param {string} [name="auro-flightline"]still references the flightline element; update the default name in the comment (and, if applicable, the implementation) to reflect the segment element instead. - The new
.nvmrcfile appears in the diff without a visible version; ensure it explicitly specifies a Node version that matches theengines.nodeconstraint (e.g.,20) so local environments stay consistent. - Changing the default branch to
devand dropping the explicit branch protection configuration from.github/settings.ymlis a sizable workflow change—double-check that this aligns with your repo/organization standards and thatdev(and/ormain) still has the desired protection rules configured elsewhere.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `AuroFlightSegment.register` the JSDoc `@param {string} [name="auro-flightline"]` still references the flightline element; update the default name in the comment (and, if applicable, the implementation) to reflect the segment element instead.
- The new `.nvmrc` file appears in the diff without a visible version; ensure it explicitly specifies a Node version that matches the `engines.node` constraint (e.g., `20`) so local environments stay consistent.
- Changing the default branch to `dev` and dropping the explicit branch protection configuration from `.github/settings.yml` is a sizable workflow change—double-check that this aligns with your repo/organization standards and that `dev` (and/or `main`) still has the desired protection rules configured elsewhere.
## Individual Comments
### Comment 1
<location> `docs/partials/api.md:76` </location>
<code_context>
+
+### Layover
+
+This example illustrates the use of the `duration` and `iata` attribute to display station codes with the layover duration.
<div class="exampleWrapper">
</code_context>
<issue_to_address>
**issue (typo):** Use plural "attributes" when referring to both `duration` and `iata`.
Because you’re mentioning both fields, this should read "the `duration` and `iata` attributes" for grammatical correctness.
```suggestion
This example illustrates the use of the `duration` and `iata` attributes to display station codes with the layover duration.
```
</issue_to_address>
### Comment 2
<location> `docs/partials/api.md:149` </location>
<code_context>
+### Stopover and Layover
-The following illustrates an international flight with stopovers and layovers, for example, ADK to BCN.
+The following illustrates flight with a stopover and a layover.
<div class="exampleWrapper">
</code_context>
<issue_to_address>
**issue (typo):** Add article "a" before "flight" for correct grammar.
You could write: “The following illustrates a flight with a stopover and a layover.”
```suggestion
The following illustrates a flight with a stopover and a layover.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ### Layover | ||
|
|
||
| This example illustrates the use of the `duration` and `iata` attribute to display station codes with the layover duration. |
There was a problem hiding this comment.
issue (typo): Use plural "attributes" when referring to both duration and iata.
Because you’re mentioning both fields, this should read "the duration and iata attributes" for grammatical correctness.
Suggested change
| This example illustrates the use of the `duration` and `iata` attribute to display station codes with the layover duration. | |
| This example illustrates the use of the `duration` and `iata` attributes to display station codes with the layover duration. |
| ### Stopover and Layover | ||
|
|
||
| The following illustrates an international flight with stopovers and layovers, for example, ADK to BCN. | ||
| The following illustrates flight with a stopover and a layover. |
There was a problem hiding this comment.
issue (typo): Add article "a" before "flight" for correct grammar.
You could write: “The following illustrates a flight with a stopover and a layover.”
Suggested change
| The following illustrates flight with a stopover and a layover. | |
| The following illustrates a flight with a stopover and a layover. |
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.
Alaska Airlines Pull Request
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Reviewer Checklist:
Documentation Accuracy
Stringproperties displaying all of their "options"?indexpage (i.e. only the most "basic" example(s) of component)installpage and renders as expectedCode Changes
myExample.html->my-example.html)perfcommit to trigger a release, as expected?Visual Checks
See Codeaccordions actually render the code blocks under their respective examplesBy submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.
Thank you for your submission!
-- Auro Design System Team
Summary by Sourcery
Modernize and reorganize flightline component documentation, improve component metadata and packaging, and update repository workflows and settings.
Enhancements:
Build:
CI:
Documentation:
Tests:
Chores: