mi6 / mi6/ic-design-system

Improve the website layout

Open
#600 0 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?
Improve the website layout to cater for development docs better, among other documentation. Other design systems break up the documents into:
- Utilities
- Canary release section
- Testing
- Theme
- etc

## Why do we need it?
To improve the experience and create a home for developers to go, at the minute some of it is hidden in "Get started" where it might not belong

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

Review the current website documentation structure, especially the content currently hidden under “Get started,” and compare it with the suggested Utilities, Canary release, Testing, and Theme sections. Done means producing an agreed layout that gives development documentation a clear home and improves the documentation experience.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.