Skip to content

v0.5 Documentation Plan

Documentation updates to ship alongside OntoLogos v0.5 (OWL EL classifier, query crate, CLI profile routing).

Status: Complete · Target release: v0.5.0

Goals

  1. Remove the largest v0.4 documentation footguns without requiring users to read disclaimers in five places.
  2. Align CLI command names with industry expectations where possible.
  3. Document EL classification and query APIs at the same quality level as RDFS/RL guides.

CLI changes (document when implemented)

Item v0.4 docs today v0.5 doc action
classify runs RDFS only Warn everywhere Document real OWL EL/RL taxonomy classification OR rename RDFS command to materialize-rdfs and reserve classify for EL
OWL RL in CLI Library/Python only Add CLI saturation path; update capability matrix
explain stub Documented as stub Replace with v0.6 plan if still stub; hide from --help until ready
--help footer Minimal Add capability matrix summary

New / updated guides

Document Action
getting-started/owl-el-classification.md Create — mirror RDFS/RL guide structure
getting-started/rdfs-materialization.md Update cross-links when classify behavior changes
guides/choosing-an-api.md Wire EL + query paths; update decision tree
guides/python.md Document profile="el" and profile="auto" when implemented
reference/cli.md Full command reference for routed profiles
index.md capability matrix Flip EL and CLI RL columns to Available
migration/v0.4.x-to-v0.5.0.md Create — breaking changes, classify semantics

API documentation (rustdoc)

Crate Action
ontologos-core Document Reasoner::classify() dispatch if wired; otherwise keep delegate docs
ontologos-el Full crate-level example for taxonomy classification
ontologos-query Query API examples

README / release notes

  • Slim README capability table — EL row moves to "Use today"
  • CHANGELOG v0.5 section with doc links
  • GitHub release notes from .github/release/v0.5.0.md

Verification checklist

  • [x] mkdocs build --strict passes
  • [x] All docs.rs links pinned to released version
  • [x] FAQ updated for new classify semantics
  • [x] Comparison matrix updated (EL available)
  • [x] Conformance doc lists EL Tier B coverage
  • [x] Python guide: default profile behavior documented
  • [x] No broken links in FAQ (RTD absolute URLs or relative from docs/)