gajus / gajus/gitdown

Improve documentation of the Contents

Open
#23 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
450
Forks
50
PR merge metrics
No merged PRs in 30d

Description

It is not clear at the moment what is the input and what is the output of using contents function.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the contents function and its existing documentation in the repository, then read how the function is used. Update the documentation to state clearly what the input is and what output it produces; the issue is complete when both are unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.