earnOS Navigator

Metadata and Linking Standard

Owner: Group PMO Reviewed: 2026-02-24 Read: 1 min Repo: earnOS

Summary

Every markdown page in earnOS and linked entity repositories must include:

Decision Points

  • `id`: globally unique, lowercase, dot-separated.
  • `title`: sentence case preferred.
  • `domain`: must match sidebar domain taxonomy.
  • `owner`: role-based, not personal names.
  • `related_entities`: use entity codes only.

Metadata and Linking Standard

Required Frontmatter

Every markdown page in earnOS and linked entity repositories must include:

id: eos.domain.slug
title: Human-readable title
domain: governance | entities | entity-interfaces | shared-services | provider-governance | group-finance | wiki
owner: Role, team, or accountable function
related_entities: [AT, AG, AGH, ALP, EBS]
canonical_url: https://earninternational.net/<canonical-path>/
repo: earnOS | atOS | agOS | aghOS | alpOS | ebsOS
last_reviewed: YYYY-MM-DD

Field Rules

  • id: globally unique, lowercase, dot-separated.
  • title: sentence case preferred.
  • domain: must match sidebar domain taxonomy.
  • owner: role-based, not personal names.
  • related_entities: use entity codes only.
  • canonical_url: production URL for deep linking.
  • repo: authoritative source repository.
  • last_reviewed: ISO date and mandatory for governance pages.
  • summary: short briefing abstract for cards and search previews.
  • entity_badges: impacted entities for quick filtering.
  • nav_weight: explicit ordering priority within a domain.
  • doc_type: one of briefing | policy | interface | registry | standard.
  • estimated_read_minutes: skim-time estimate used in page headers.

Canonical Naming Conventions

  • File names: kebab-case.md
  • Canonical path: /<domain>/<slug>/
  • ID pattern:
    • Group docs: eos.<domain>.<slug>
    • Entity docs: <entity-code-lower>.<domain>.<slug>
  • Intra-earnOS links: relative markdown links.
    • Example: [Provider Registry](PROVIDER-REGISTRY.md)
  • Cross-repo deep links: absolute canonical URLs.
    • Example: [AT leave policy](https://earninternational.net/entities/at/hr/leave-policy/)
  • Source repository links: absolute Git links only where implementation context is needed.
    • Example: https://github.com/<org>/atOS/blob/main/docs/hr/leave-policy.md
  • Never link to non-canonical temporary routes or branch preview URLs in policy docs.
  • Anchor headings must remain stable after publication.
  • If path changes, implement HTTP redirect from old canonical URL.
  • Maintain link aliases in entity repos for high-traffic pages.