mi6 / mi6/ic-design-system

Make guidance clear for ic-stepper compact variant

Open
#538 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
79
Forks
52
Avg merge
18h 58m
Merged PRs (30d)
4

Description

What is the purpose of the work?

If a step-type of current is not passed to an ic-step then the stepper in compact variant will not render on smaller screens. Code guidance has compliant step-types throughout but it may be worth emphasising this point in the guidance tab of ic-stepper

Why do we need it?

This may help to prevent issues when devs are developing using ic-stepper in compact variant

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the ic-stepper guidance tab and review how compact variants describe the required step-type. Update the guidance to emphasize that a current step-type must be passed to ic-step so compact rendering works on smaller screens.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.