ACES-RMDSSOE / ACES-RMDSSOE/share

Documentation

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

Description

# What needs to be done?

- Make documentation for all files (Important ones not actually all) such that anyone new can understand what's going on
- Documentation should be concise and technical to an extent (Shouldn't explain every small thing but don't be too simple)
- Make an `Overview.md` with simple description of each file and folder

## Additional Things

If possible don't make typos 👽
There is already a `docs/` folder, put things not suitable for comments in files over there (Like about schema) as well as clean up other files in `docs/` folder

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.