mi6 / mi6/ic-ui-kit

Suggestion: Glossary to the ic-ui-kit repo

Open
#2,798 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
53
Forks
63
Avg merge
2d 4h
Merged PRs (30d)
15

Description

## Summary
A lot of well seasoned projects has user guides, like this one from [NASA](https://nasa.github.io/openmct/static/files/Open_MCT_Users_Guide.pdf).

## 💬 Description
By adding a dictionary/user guide/glossary document, you make it easier for new contributors working on core logic to work on the project. It will also make the overall project documentation very good. To make it easier, you can host the user guide/glossary through GitHub pages.

## Why do we need it?
See above

Contributor guide

Open the contributing guide

Research direction

The issue does not name any files, tests, or documentation entry points. Start by reviewing the repository's existing documentation and GitHub Pages setup, then define the glossary's scope and confirm that the completed guide is published and useful to new contributors.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.