pepkit / pepkit/pephub

Add docs on config

Open
#307 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation likely solved
Dominant language
TypeScript
Stars
22
Forks
2
PR merge metrics
No merged PRs in 30d

Description

for a new user unfamiliar with PEP, It's not clear what you can do with config (derived columns etc).
It would be nice to get some links/explanations about subsamples and 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

Start by locating the existing documentation for config and subsamples, then review what a new PEP user can currently learn from it. Add links and explanations covering config capabilities such as derived columns and subsamples; done means a newcomer can understand what config supports and where to learn more.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.