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

Add a brief description of the component #42

Open
6 tasks
seohyunsim opened this issue Oct 29, 2022 · 0 comments
Open
6 tasks

Add a brief description of the component #42

seohyunsim opened this issue Oct 29, 2022 · 0 comments
Labels
docs Modifying and creating documents good first issue Good for newcomers

Comments

@seohyunsim
Copy link
Collaborator

This is issue for editing the typeDoc of component.
If you don't know the typeDoc, check the following link: typeDoc Tutorial, typeDoc Official.

Description

Among the descriptions of the components, the newly added component has no description.
Therefore, we add a brief description of the newly added components.

Modification Components

  • ProgressBar
  • Skill
  • Channel

Progress by component

  1. ProgressBar
  • Add @component and description in ProgressBar typeDoc.
  • Add @link in ProgressBar typeDoc.
  1. Skill
  • Add @component and description in Skill typeDoc.
  • Add @link in Skill typeDoc.
  1. Channel
  • Add @component and description in Channel typeDoc.
  • Add @link in Channel typeDoc.

Reference

You need to add descriptions about both steps First and Second in the Components as follows.

First

You must specify the name of the component and add it if you need a brief explanation.

image

Second

You need to add a @link that can be routed to README.md that can be referenced for the props of the Component.

image

Expected results

After going through both of the above two steps, you can expect the results below.

image

❗ Caution

Please write this typeDoc directly above where the component is declared.

@seohyunsim seohyunsim added good first issue Good for newcomers docs Modifying and creating documents labels Oct 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Modifying and creating documents good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant