INCATools / INCATools/ontology-development-kit

The ODK needs its own reference documentation

Open
#1,351 1 comment 0 reactions 1 assignee Claimed by @gouttegd View on GitHub
documentation
Dominant language
Dockerfile
Stars
375
Forks
69
Avg merge
3d 5h
Merged PRs (30d)
7

Description

Right now, the documentation available on the [ODK’s own website](https://incatools.github.io/ontology-development-kit/) is sparse. Most of the real user-facing documentation is delegated to the OBOOK.

I don’t think delegating all the documentation to the OBOOK is a good idea. At least one obvious problem with that is that it’s very easy for the documentation to fall out of sync with the code.

It may be fine to have tutorials, how-tos, and maybe FAQS on the OBOOK, but _reference documentation_ at the very least should be maintained directly from within the ODK project, independently of the OBOOK.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.