Skip to content

docs: the virtual crate serves property names as deposited and hides files not held - #79

Merged
johnf merged 2 commits into
mainfrom
worktree-adr-0004-normalised-virtual-crate
Nov 17, 2026
Merged

johnf merged 2 commits into
mainfrom
worktree-adr-0004-normalised-virtual-crate

Conversation

@johnf

@johnf johnf commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Records two decisions from the indexer redesign ticket "What the indexer derives from a crate" (#69) in the domain docs. Docs only; no code changes.

What changes

  • ADR 0004 now says how the virtual crate differs from the deposited crate, and what it leaves alone:
    • A File entity whose content the repository doesn't hold gets display: false, which Oni reads to hide the preview and download.
    • Property names are served as deposited. Crates are assumed to use the prefixed LDaC and PCDM spelling (ldac:communicationMode, pcdm:memberOf); the indexer reads only that form and the virtual crate doesn't rename the older one (communicationMode, memberOf). Updating an older crate is its owner's job.
    • The crate in the repository is never changed.
  • GLOSSARY.md gains three terms: virtual crate, metadata-only crate, shared entity.

An earlier version of this PR had the virtual crate rewritten to the prefixed spellings. That decision was reversed on 2026-11-17; the second commit carries the change.

Before merging

The ADR describes the design the indexer redesign (map: #65) is heading to, not what main does today: the indexer still reads both spellings (values in src/indexer/search.ts, memberOf in src/indexer/indexer.ts, pickSingleMemberOf in src/indexer/database.ts), the test crates under test-data/ still use the older communicationMode and indexableText, and entityAsCrate doesn't set display yet. Merge this with the implementation, or earlier if you're happy for the ADR to lead the code.

The full decision, with what was rejected and why, is in the resolution comment on #69.

Records the decisions from #69. The virtual crate renames LDaC and PCDM properties to their
prefixed forms and marks files the repository doesn't hold with display: false. The deposited
crate is never changed. Adds virtual crate, metadata-only crate and shared entity to the glossary.
The virtual crate no longer renames the older context-only spellings
(communicationMode, memberOf), and the indexer reads only the prefixed
forms. Updating an older crate is its owner's job.
@johnf johnf changed the title docs: the virtual crate is normalised to ldac: and pcdm: spellings docs: the virtual crate serves property names as deposited and hides files not held Nov 17, 2026
@johnf
johnf marked this pull request as ready for review November 17, 2026 02:15
@johnf
johnf merged commit 019e452 into main Nov 17, 2026
5 checks passed
@johnf
johnf deleted the worktree-adr-0004-normalised-virtual-crate branch November 17, 2026 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant