jetvil / jetvil/cm-api

Write documentation

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
TypeScript
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

For the 'end-user' to have a good DevX, the documentation needs to be on point, meaning there has to be documentation for every in and output value this program generates or requires to run.

example:
- `isString`: parameter(s): `string`, returns: `boolean`, default: None.

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.