libre-study/libre-bible-data
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Phase 3 expand machine catalogs

Browse Source
This commit is contained in:
Jason
2026-07-11 22:10:34 -05:00
parent afeb2c4d3b
commit 564eaea5a0
7 changed files with 271 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONVENTIONS.md
+8
View File
@@ -99,6 +99,14 @@ Attachment metadata should identify:
- Build/import scripts should fail when required source, license, checksum, or package metadata is missing.
- The public catalog must not silently disagree with the source manifest.
## Machine Catalogs
- `packages/json/catalog.json` is the machine-readable index for ChristIT.com, Libre Study, GracePress Bible Tooltip, and future consumers.
- Per-resource package catalogs, such as `packages/json/<resource-id>/catalog.json`, should carry the full resource metadata needed to render a public detail page without scraping Markdown.
- Machine catalogs should include schema version, project name, resource id, resource type, title, abbreviation, language, script, canon, translation/edition metadata, contributors, features, attachments, source, license, display summary, package paths, counts, file checksums, and source check metadata.
- Markdown docs are a human-readable projection of the same metadata. They must not become a separate truth source.
- Public ChristIT.com pages and app/plugin package discovery should read machine catalogs first, then link to Markdown docs for explanation.
## Update Workflow
- Update checks must be mechanical and repeatable.