Skip to content

docs: 📚 wrong template for sd-prose #2982

Description

@mariohamann

Description

The sd-prose example is completely wrong: https://solid-design-system.fe.union-investment.de/docs/?path=/docs/styles-sd-prose--docs#default-5

<div class="sd-prose sd-prose--full-width flex flex-col gap-8">
      <h1 class="sd-headline">H1 - Nisi eu excepteur anim esse</h1>
      <h2 class="sd-headline sd-headline--size-3xl">H2 - Nisi eu excepteur anim esse</h2>
      <sd-divider></sd-divider>
      <h3 class="sd-headline sd-headline--size-xl">H3 - Nisi eu excepteur anim esse</h3>
      <h4 class="sd-headline sd-headline--size-lg">H4 - Nisi eu excepteur anim esse</h4>
      <h5 class="sd-headline sd-headline--size-base">H5 - Nisi eu excepteur anim esse</h5>
      <p class="sd-paragraph">
        Paragraph - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nibh justo ullamcorper odio tempor molestie
        phasellus dui vel id.
      </p>
      <p class="sd-paragraph">
        <strong>
          Paragraph Bold - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nibh justo ullamcorper odio tempor
          molestie phasellus dui vel id.
        </strong>
      </p>
      <p class="sd-leadtext">
        Leadtext - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nibh justo ullamcorper odio tempor molestie
        phasellus dui vel id. Velit in sed non orci pellentesque vivamus nunc. At non tortor, sit neque tristique.
        Facilisis commodo integer hendrerit tortor.
      </p>
      <blockquote>Blockquote - Lorem ipsum dolor sit amet, consetetur sadipscing elitr.</blockquote>
      <sd-divider></sd-divider>
      <sd-link href="https://www.union-investment.de/">Inline link</sd-link>
      <sd-link href="https://www.union-investment.de/"><strong>Inline link strong</strong></sd-link>
      <ul>
        <li>
          Unordered list level 1
          <ul>
            <li>
              Unordered list level 2
              <ul>
                <li>Unordered list level 3</li>
              </ul>
            </li>
          </ul>
        </li>
        <li>Unordered list level 1</li>
        <li>Unordered list level 1</li>
      </ul>
      <figure class="sd-media p-4">
        <img src="./placeholders/images/generic.jpg" alt="A generic placeholder jpg" class="aspect-video object-cover">
        <figcaption>
          Figcaption - Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula
        </figcaption>
      </figure>
      <table class="sd-table">
        <thead>
          <tr>
            <th class="sd-table-cell">Header</th>
            <th class="sd-table-cell">Header</th>
            <th class="sd-table-cell">Header</th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
          </tr>
          <tr>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
          </tr>
          <tr>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
          </tr>
          <tr>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
          </tr>
          <tr>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
            <td class="sd-table-cell">Cell Content</td>
          </tr>
        </tbody>
      </table>
    </div>
  

Requirement

It should only have the class sd-prose, not all the other stuff like sd-headline etc.

Where to put the documentation

Everywhere in sd-prose this should be checked.

DoR

  • Item has business value
  • Item has been estimated by the team
  • Item is clear and well-defined
  • Item dependencies have been identified

Metadata

Metadata

Labels

Type

Fields

No fields configured for Bug.

Projects

Status
👀 In review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions