department-of-veterans-affairs / va-mobile-library

https://department-of-veterans-affairs.github.io/va-mobile-library/
ISC License
0 stars 0 forks source link

BUG - Sev-3 - Web - Fix custom docs template #176

Closed narin closed 1 month ago

narin commented 4 months ago

What happened?

We were previously using a custom docs template for Storybook to prepend a link to the documentation site. Upgrading to Storybook 7 broke this somewhat, because code snippets no longer worked when using a custom template. This might be fixable, but it might also be a Storybook bug.

Steps to Reproduce

  1. Re-add the following docs parameter to one of the component stories. e.g.
    parameters: {
    docs: generateDocs({
      name: 'Button',
      docUrl:
        'https://department-of-veterans-affairs.github.io/va-mobile-app/design/Components/Buttons%20and%20links/Button',
    }),
    },
  2. Load up storybook on web
  3. Go to the Docs page for the modified story
  4. Notice that "Show code" is disabled and says "No code available"

Desired behavior

We should be able to use a custom docs template with auto-generated code snippets

Acceptance Criteria

Bug Severity - BE SURE TO ADD THE SEVERITY LABEL

See [Bug Tracking](https://department-of-veterans-affairs.github.io/va-mobile-app/docs/QA#issue-severity) for details on severity levels

Linked to Story

Screen shot(s) and additional information

image.png
bischoffa commented 2 months ago

Unable to add severity label to this ticket. @narin can you please add it