ImranR98/apps.obtainium.imranr.dev

Lack of Documentation for JSON Configuration

Open

#1,068 opened on Dec 20, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Astro (156 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (549 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I was searching both this and the obtanium repo and I noticed there isn't really any documentation (at least as far as I can find) on the JSON configuration format as far as what the fields are and how to use them.

Could someone please add this, either to the readme or maybe the github's wiki?

Contributor guide

Research direction
Examine the current README and the repository's JSON data files to understand the configuration format. Then propose additions to document the fields and usage examples.
Tech stack
astro
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80