Skip to content

docs(ia): restructure documentation information architecture

Ashley HARWOOD requested to merge docs/ia-restructure into main

Summary

This merge request (MR) restructures the UN Critical Raw Materials Transparency Protocol (CRMTP) documentation to implement the new information architecture with a 3-layer nested folder hierarchy.

New Structure

website/docs/
├── about/                                    # Flat structure
│   ├── index.md                              # About CRMTP + This Site
│   ├── governance.md                         # Licensing, Governance, FAQs (merged)
│   └── meetings.md                           # Overview, Collaboration Channels
├── business-case/                            # Flat structure (unchanged)
├── specification/                            # 3-layer hierarchy
│   ├── index.md
│   ├── conceptual-mapping.md                 # NEW
│   ├── digital-product-passports/            # NEW folder
│   │   ├── index.md
│   │   ├── digital-copper-passport.md
│   │   ├── digital-cobalt-passport.md
│   │   ├── digital-nickel-passport.md
│   │   └── digital-graphite-passport.md
│   ├── traceability-events/                  # NEW folder
│   │   ├── index.md
│   │   └── crm-processing-event.md
│   ├── conformity-credentials/               # NEW folder
│   │   ├── index.md
│   │   ├── copper-mark-credential.md
│   │   ├── irma-credential.md
│   │   └── consolidated-mining-standard.md
│   ├── identifiers.md
│   ├── vocabularies.md
│   └── verification.md
├── guidance/                                 # Simplified
│   └── index.md
├── register/                                 # Flat structure (unchanged)
└── _archive/                                 # NEW - archived files

Key Changes

  • Specification section: Now uses 3-layer nested folders for Digital Product Passports, Traceability Events, and Conformity Credentials
  • FAQ merged into Governance: Consolidated FAQ content as a section within the governance page
  • Archived unused files: Moved unused files to _archive/ folder with draft: true
  • Updated internal links: All cross-references updated to reflect new paths
  • Index pages cleaned up: Tables with links to child pages, removed redundant sections
  • Consistent page structures: All DPP pages follow same structure (Example, Ontology, Logical Model, etc.)
  • All DCC pages follow same structure: Human readable PDF, Ontology, Core Vocabularies, etc.

Sidebar Screenshot

Screenshot_2026-01-26_at_7.46.02_am Screenshot_2026-01-26_at_7.39.06_am

Bug Fix Included

Fixed version banner component to use projectShortName from docusaurus config instead of hardcoded "United Nations Transparency Protocol".

Edited by Ashley HARWOOD

Merge request reports

Loading