Skip to content

Conversation

@jordanjones243
Copy link
Contributor

example code updated to reflect latest Auro element APIs example documentation layout improved
custom registration updated and moved to install page 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

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.

Checklist for PR Reviewer

Documentation Accuracy

  • Do all explanations in the API table convey the feature they are referencing in an understandable way?
    • Are all String properties displaying all of their "options"?
  • Are all necessary API features documented? Are there any missing that you believe should be added?
  • Does the component description and use case section convey what the component is all about? Is there too much or too little information?
  • Ensure only NECESSARY examples are on the index page (i.e. only the most "basic" example(s) of component)
  • Are the API examples more or less appearance in the same order as they are in on the API table?
  • Ensure custom registration example is now on install page and renders as expected
  • Do all functional JS examples still work?

Code Changes

  • Ensure all example files are rename from camel case to kebab case (ex. myExample.html -> my-example.html)
  • Ensure no backticks appear in example header names
  • Is there a perf commit to trigger a release, as expected?

Visual Checks

  • Ensure all See Code accordions actually render the code blocks under their respective examples
  • Do all examples with multiple components in them have sufficient spacing?
RC Checklist

Testing Checklist:

Browsers

Browsers Support Guide

Dev demo link

Android

  • Chrome
  • Firefox

iOS

  • Chrome
  • Firefox
  • Safari

Desktop

  • Chrome
  • Firefox
  • Safari
  • Edge

Scenarios

  • Validated linked issues with issue reporting team
  • Test coverage report review

Framework playground

  • Next React
  • SvelteKit

**By 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

example code updated to reflect latest Auro element APIs
example documentation layout improved
custom registration updated and moved to install page
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
@jordanjones243 jordanjones243 self-assigned this Jan 5, 2026
@jordanjones243 jordanjones243 requested a review from a team as a code owner January 5, 2026 02:12
@jordanjones243 jordanjones243 marked this pull request as draft January 5, 2026 02:12
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @jordanjones243, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@jordanjones243
Copy link
Contributor Author

Blocked until it is determined how to document the hyperlink properties that are listed due to class extensions, as well as getting the repo updated with the doc modernization changes.

@jordanjones243 jordanjones243 linked an issue Jan 5, 2026 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Jan 5, 2026

🚀 PR Release Published! v0.0.0-pr110.0

To install:

npm install @aurodesignsystem-dev/auro-nav@0.0.0-pr110.0

Install via alias:

npm install @aurodesignsystem/auro-nav@npm:@aurodesignsystem-dev/auro-nav@0.0.0-pr110.0

View on npmjs.com

@github-actions
Copy link

github-actions bot commented Jan 5, 2026

Component Demo Links

nav: https://auro-nav-110.surge.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

nav - modernize documentation

2 participants