Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for ItemList and content in Timeline component #50

Closed
MagdalenaLarge opened this issue Jul 8, 2024 · 0 comments · Fixed by ONSdigital/design-system#3279
Assignees
Labels
Component Component of Design System Documentation Improvements or additions to documentation Medium Priority

Comments

@MagdalenaLarge
Copy link

As Software Developer
I want Timeline component to have updated documentation for two parameters - ItemList and content
So that user knows dependencies within this component

Description
For the timeline component, we need to update the documentation for two parameters - ItemList and content. The description should be updated to clarify their dependency on each other. Specifically, itemList should only be set when content is not set, and vice versa.

Currently documentation is not stating this dependency clearly in Nunjucks micro options

Acceptance Criteria

  1. Documentation for two parameters ItemList and content is updated
  2. User can clearly identify dependencies for both parameters

Visualisation/Input from UCD

Visual representation where the issue is currently in Design System.

Image

Linked User stories/epics

Technical details (optional)
MVP (optional)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component Component of Design System Documentation Improvements or additions to documentation Medium Priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants