Skip to content

Core Model & Identity Documentation #885

@morri-son

Description

@morri-son

Description
Create a general intro to OCM in Overview section explaining OCM's core model at high level. Then create a comprehensive Concepts doc merging existing Components + Coordinates docs and adding the Component constructor.

Current state:

  • overview/ has benefits + project but no core model intro
  • concepts/components.md + concepts/coordinates.md separate
  • Component descriptor/constructor explained in getting-started but not in concepts

Target:

  • Overview: High-level intro to OCM's identity model (what/why)
  • Concepts: Deep technical explanation (how it works)

Tasks:

  • content/docs/overview/core-model.md (NEW or adjusted) - High-level intro: what is component identity, why it matters, basic mental model (unify with how ocm works)
  • content/docs/concepts/component-identity.md (NEW) - Merge components.md + coordinates.md; add component descriptor structure, constructor, CTF format
  • content/docs/concepts/components.md (DELETE) - Content moved
  • content/docs/concepts/coordinates.md (DELETE) - Content moved
  • content/docs/getting-started/create-component-version.md (REWORK) - Link to new docs we already have
  • content/docs/tutorials/component-descriptor-example.md (REVIEW) - Cross-link to concept doc (we should already have that)

Done Criteria

  • Overview doc: high-level explanation, accessible to newcomers
  • Concept doc: technical details on component identity, version, coordinates, descriptors etc.
  • No duplicate content
  • All relrefs updated

Metadata

Metadata

Labels

area/documentationDocumentation relatedarea/ipceiImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epic

Type

No type
No fields configured for issues without a type.

Projects

Status
🔍 Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions