Skip to content

feat: Component docs improvement #3371

Open

Description

@MartaPintoTeixeira

Description

This tasks describes the Figma implementation for: docs: Improve navigation and content discoverability in SDS Storybook #3367

Ideas:

  • Add current development status and versioning to each component and style
  • Improve usage guidelines to make sure topics are clear and dont overlay (tip: we only need to cover what has to be checked by the user)
  • Add a Feedback section for contribution in each component page (reminder: feedback flow to be considered)
  • Skeleton preview available per component (question: do we want this? if yes in which components is this essencial?)
  • Improve docs to know where to write ally info and how - internal
  • Docs include best practices (do’s and donts) - good for agents
  • Components have table of contents so user know what to expect in the page and this works as jump links

Open Questions towards development

  • Question1
  • Question2

DoR

  • Item has been estimated by the team
  • Item dependencies have been identified and documented

DoD

  • Brand approval (if neccessary)
  • Figma documentation file incl. hand-off has been created/updated (if applicable)
  • Tokens have been applied/updated (if applicable)
  • Crosslinks are created/updated
  • Implementation works successfully on figma branch

Metadata

Metadata

Labels

Designneeds changes in FigmaSubtaskEpic subtasks

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions