openworm / openworm/openworm_docs

Add .openworm.yml metadata to geppetto repositories

Open
#69 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
45
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Automated repository crawler for the documentation would be lacking several geppetto libraries. This issue is to add a basic .openworm.yml to libraries in the geppetto project that indicates the relationships between them.

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 examining the documentation crawler and the geppetto repositories it is intended to scan; the issue does not name specific libraries or an existing .openworm.yml example. Determine the metadata schema and repository relationships from the crawler, then add basic .openworm.yml files to the relevant libraries and verify that they are discovered correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.