Add HDMF ↔ LinkML mapping conventions documentation#1492
Conversation
Document how HDMF Schema Language constructs map to LinkML for the initial scope (base.yaml and CSRMatrix, as a minimal test namespace), and add it to the docs toctree. Addresses #1487. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #1492 +/- ##
=======================================
Coverage 93.18% 93.18%
=======================================
Files 41 41
Lines 10176 10176
Branches 2103 2103
=======================================
Hits 9483 9483
Misses 415 415
Partials 278 278 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@jwbear This is an initial pass of a document that describes the mapping between HDMF Schema Language and LinkML. Please translate |
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Fixes #1487
Motivation
This adds the initial HDMF ↔ LinkML mapping conventions document, the first deliverable of the "Read and write LinkML schema for HDMF (CSRMatrix / base.yaml)" epic (#1486). Before any reader, writer, or fixtures are built, we need an agreed, written contract for how HDMF Schema Language (HDMFSL) constructs map to LinkML, so that the translation round-trips faithfully into HDMF's
Specobjects. This doc is that contract.It is scoped to the constructs used by
base.yaml(Data,Container,SimpleMultiContainer) andsparse.yaml(CSRMatrix), packaged as a minimal test namespace, and explicitly marks what is out of scope so it is not mistaken for a complete mapping.The new file is
docs/source/linkml_mapping.rst, added to the "Resources" toctree indocs/source/index.rst.How to test the behavior
Verified: the docs build with 0 warnings,
linkml_mapping.htmlrenders, and the page appears under the Resources toctree.Checklist
CHANGELOG.md?