NASA-AMMOS / NASA-AMMOS/AIT-Core

Clarify purpose of data paths in docs or remove from example config

Open
#166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
56
Forks
35
Avg merge
1d 20h
Merged PRs (30d)
3

Description

New users are confused about the purpose of the data paths in the example config. Either clarify further within the docs or remove them from the example config.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the documentation and example config to identify where the data paths are introduced and how their purpose is described. Done means either explaining the paths clearly for new users or removing them from the example config, with the affected documentation and configuration remaining consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.