pepkit / pepkit/pephub

Add docs on how to create/select a schema

Open
#306 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

Right now it's hard to find information on schemas. I think we need

  • A tooltip that would point to further reading

  • docs that answer:

  • what are schemas?

  • how does validation work?

  • how do I create my own schema?

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

No files or tests are named. Start by locating the existing schema documentation and the UI area where a tooltip could point to further reading; done means explaining what schemas are, how validation works, how to create a schema, and providing that tooltip.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.