ant-design / ant-design/HiTu

Documentation Page

Open
#5 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
28
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Could we create some kind of documentation page for this package?
Currently it is impossible to know how to use the package when not having the repo cloned.

I added some additional pages to the storybook to get the components for myself like seen in this screenshot:
![image](https://user-images.githubusercontent.com/11338472/125917824-43c2f492-9590-4aaf-a942-bf3a0181bc13.png)

My proposal is to add some pages to the storybooks first, make them searchable, and afterward create some kind of search page like: https://ant.design/components/icon/

I am willing to do it if someone approves it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing Storybook pages and the additional component pages described in the issue. Clarify the documentation scope and approval first; done would mean the package has accessible, searchable documentation pages, with the proposed search page treated as a later phase.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.