traefik / traefik/faency

Use README content in Introduction story

Open
#167 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/task
Dominant language
TypeScript
Stars
41
Forks
16
Avg merge
3d 1h
Merged PRs (30d)
3

Description

Feature request

Overview

Instead of having a blank page on the storybook welcome page, we could put the README content. Stories can be written using markdown.

Contributor guide

No contributing guide indexed for this repository

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 by locating the Storybook welcome or Introduction story and the repository README. Check how stories currently render markdown, then use the README as the Introduction page content. Done means the welcome page is no longer blank and displays the README content correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
2/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.