Further doc updates

EBISPOT · Jun 21, 2024 · 9babe12 · 9babe12
1 parent f0524d7
commit 9babe12
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ Class Count: 1045
 - Moved from HERMIT to ELK as our ontology reasoner
 	- Adjusted some axiomatisations to conform to OWL2-EL to maintain reasoned hierarchy with ELK.
 
-See the [release notes](https://github.com/EBISPOT/hancestro/releases) for further details of most recent changes.
+See the [release notes](https://github.com/EBISPOT/hancestro/releases) for further details of most recent changes or check out our new [automatically generated ontology diff report](https://github.com/EBISPOT/hancestro/blob/main/src/ontology/reports/release-diff.md).
 
 
 

diff --git a/docs/odk-workflows/ReleaseWorkflow.md b/docs/odk-workflows/ReleaseWorkflow.md
@@ -32,8 +32,9 @@ This will create all the specified release targets (OBO, OWL, JSON, and the vari
 1. (Optional) Rough check. This step is frequently skipped, but for the more paranoid among us (like the author of this doc), this is a 3 minute additional effort for some peace of mind. Open the main release (hancestro.owl) in you favourite development environment (i.e. Protégé) and eyeball the hierarchy. We recommend two simple checks: 
     1. Does the very top level of the hierarchy look ok? This means that all new terms have been imported/updated correctly.
     2. Does at least one change that you know should be in this release appear? For example, a new class. This means that the release was actually based on the recent edit file. 
-2. Commit your changes to the branch and make a pull request
-3. In your GitHub pull request, review the following three files in detail (based on our experience):
+2. Build a diff report with the previous release by running `sh run.sh make release_diff`
+3. Commit your changes to the branch and make a pull request
+4. In your GitHub pull request, review the following three files in detail (based on our experience):
     1. `hancestro.obo` - this reflects a useful subset of the whole ontology (everything that can be covered by OBO format). OBO format has that speaking for it: it is very easy to review!
     2. `hancestro-base.owl` - this reflects the asserted axioms in your ontology that you have actually edited.
     3. Ideally also take a look at `hancestro-full.owl`, which may reveal interesting new inferences you did not know about. Note that the diff of this file is sometimes quite large.