Skip to content

Commit bd4951d

Browse files
authored
Merge pull request #178 from OBOFoundry/usage-docs
usage docs
2 parents 24855fc + 1ed693e commit bd4951d

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

docs/using-cob.md

+18-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
1-
# Using COB
1+
# Using COB: An ontology developers guide
22

3-
## Using COB: An ontology developers guide
3+
If you are part of a team that is responsible for creating or maintaining an OBO ontology, then read on for a description of how you can use COB with your ontology
44

5-
It is too early for you to start using COB classes directly as an upper level in your ontology
5+
## Add yourself to the OBO bridge
66

7-
1. Create a [*base* file](https://github.com/INCATools/ontology-development-kit/blob/master/docs/ReleaseArtefacts.md#release-artefact-1-base-required)
8-
2. Add bridging axioms to your root to [cob-to-external.tsv](cob-to-external.tsv)
9-
3. Add your ontology to the Makefile under integration tests
7+
See [Bridging COB to OBO](obo-bridge) for instructions on how to make sure your ontology's root terms are mapped to COB
108

11-
##
9+
## Use a COB import
10+
11+
Here we assume you are familiar with standard OBO tools such as [ROBOT](http://robot.obolibrary.org/) and the [ROBOT extract](http://robot.obolibrary.org/extract) command, or you are using the [ODK]((https://github.com/INCATools/ontology-development-kit) to make releases.
12+
13+
If you are already using a BFO import modify your build process to instead use COB
14+
15+
If you are configuring an ontology for the first time using the ODK, then all you need to is declare `cob` as one of your input ontologies. You should do this in place of bfo-classes (don't worry, you will still get bfo-classes via COB).
16+
17+
18+
## Using COB for end-users
19+
20+
If you are not an ontology developer or directly involved in the construction of one more ontologies, then there is not much opportunity to "use" COB.
21+
22+
We are hoping that we can manage a roll-out of COB to

mkdocs.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ nav:
55
- Tour:
66
- Exploring COB: exploring.md
77
- Placing OBO ontologies under COB: obo-bridge.md
8+
- Using COB: using-cob.md
89
- Integration Tests: integration-tests.md
910
- Editors Readme: editors.md
1011
- How-to guides:

0 commit comments

Comments
 (0)