AlaskaAirlines / AuroDocsSite

Repository for the management of the Auro doc site
https://auro.alaskaair.com/
0 stars 0 forks source link

fix: hyperlinks will build correctly #257

Closed jason-capsule42 closed 1 month ago

jason-capsule42 commented 1 month ago

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.

Summary:

Fixes issue where the hyperlinks were not building correctly

Type of change:

Please delete options that are not relevant.

Checklist:

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

Summary by Sourcery

Bug Fixes:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request fixes an issue where hyperlinks were not building correctly. The changes simplify the code by removing unnecessary variable assignments and directly returning the constructed link string.

Class diagram for hyperlink construction update

classDiagram
    class MarkdownPageWrapper {
        +String replaceLink(String link, String url)
    }
    class AuroComponentContent {
        +String replaceLink(String link, String url)
    }
    class AuroContributing {
        +String replaceLink(String link, String url)
    }
    class AuroTokenList {
        +String replaceLink(String link, String url)
    }
    class RenderMarkdownPage {
        +String replaceLink(String link, String url)
    }
    class RenderComponentPage {
        +String replaceLink(String link, String url)
    }
    MarkdownPageWrapper <|-- AuroComponentContent
    MarkdownPageWrapper <|-- AuroContributing
    MarkdownPageWrapper <|-- AuroTokenList
    MarkdownPageWrapper <|-- RenderMarkdownPage
    MarkdownPageWrapper <|-- RenderComponentPage
    note for MarkdownPageWrapper "Updated to directly return constructed link string"

File-Level Changes

Change Details Files
Simplified hyperlink construction in multiple components
  • Removed unnecessary 'newLink' variable assignment
  • Directly return the constructed link string
  • Maintained the same link structure and attributes
src/content/dynamic/_template/component.js
src/content/dynamic/contributing/contributing.js
src/content/dynamic/contributing/dod.js
src/content/dynamic/tokenlist/component.js
src/functions/renderMarkdownPage.js
src/functions/renderComponentPage.js

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).