INCATools / INCATools/ontology-development-kit

Document (or remove) the `baselite` artefact

Open
#1,102 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

One of the optional artefact the ODK can generate is `-baselite`, which (if I am not mistaken) corresponds to what used to be the `-base` artefact before we switched to the [new definition of “base”](https://oboacademy.github.io/obook/reference/base-specification/).

Seemingly the _only_ “documentation” about `-baselite` is this comment in the generated standard Makefile:

```Makefile
# baselite: All the axioms as they are editted by the editors, excluding reasoning. This is currently the same as "base". Only to be used experimentally (may disappear in future ODK releases).
```

and that comment appears to be misleading as `-baselite` is certainly not “the same as `-base`“.

If that product is supposed to remain available as an option, it should be properly documented (including in the OBOOK, in the section about [Release Artefacts](https://oboacademy.github.io/obook/reference/release-artefacts/)).

Alternatively, should that type of artefact be removed entirely, as the comment already suggests?

Contributor guide

Open the contributing guide

Research direction

Start by comparing the `baselite` comment in the generated standard Makefile with the linked base specification and the OBOOK Release Artefacts section. Determine whether `baselite` should remain available or be removed; done means the misleading comment and relevant documentation are updated consistently, or the artefact is removed.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.