INCATools / INCATools/ontology-development-kit

Improve documentation of module types

Open
#971 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Dockerfile
Stars
375
Forks
69
Avg merge
3d 5h
Merged PRs (30d)
7

Description

I noticed that the docs here https://github.com/INCATools/ontology-development-kit/blob/master/docs/project-schema.md don't reflect all the options in the Makefile template here https://github.com/INCATools/ontology-development-kit/blob/master/template/src/ontology/Makefile.jinja2#L418, or explain what the options mean. Maybe this is documented somewhere else...

Contributor guide

Open the contributing guide

Research direction

Compare docs/project-schema.md with the module-type options around line 418 of template/src/ontology/Makefile.jinja2. First identify every option in the Makefile template and check whether another documentation location already explains them. Done means project-schema.md, or the clearly referenced documentation, lists the available options and explains their meanings.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.