Skip to content

[docs] Double-check updates to all component docs #2395

Description

@markcaron

Need a once over on all docs to make sure they're accurate, have demos linked, and are ready to go.

Activity

  1. kylebuch8 commented on Feb 28, 2023

    @kylebuch8
    Contributor

    I don't think we want to link to the demo pages. Those are intended for the developers to review every possible use case of the component. I think we want to have multiple examples on the docs page and keep the demo page unlinked.

  2. zeroedin commented on Mar 10, 2023

    @zeroedin
    Collaborator

    @kylebuch8 So currently we only show the demo link overlay when NOT in prod.

    {%- if env.ELEVENTY_ENV == "prod" -%}
    <a href="{{ ('/components/'+ element.slug +'/') | url }}" aria-label="{{ element.title }}">
    <div class="preview-image" style="background-image: url({{ ('/components/'+ element.slug +'/docs/screenshot.png') | url }});"></div>
    </a>
    {%- else -%}
    <div class="preview-image" style="background-image: url({{ ('/components/'+ element.slug +'/docs/screenshot.png') | url }});"></div>
    <div class="overlay">
    <a class="cta secondary wind" href="{{ ('/components/'+ element.slug +'/demo/') | url }}">Demo</a>
    </div>
    {%- endif -%}

    Otherwise, I think we can close this issue as I think this was covered in: #2398

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions