fix: added docType segment to allow the inclusion within other files

tcouper · tcouper · commit 44865ff05963 · 2026-05-25T14:30:54.000+01:00
diff --git a/ob_v3p0/microsites/v3p0.md b/ob_v3p0/microsites/v3p0.md
@@ -218,17 +218,17 @@ releases:
     comments: "Fixed links to OpenAPI files in <a href=\"#api\">Open Badges API</a> section"
 ---
 
-@v3p0/spec/abstract.md
+@standards/v3p0/spec/abstract.md
 
-@v3p0/spec/introduction.md
+@standards/v3p0/spec/introduction.md
 
-@v3p0/spec/overview.md
+@standards/v3p0/spec/overview.md
 
-@v3p0/spec/usecases.md
+@standards/v3p0/spec/usecases.md
 
-@v3p0/spec/gettingstarted.md
+@standards/v3p0/spec/gettingstarted.md
 
-@v3p0/spec/docformat.md
+@standards/v3p0/spec/docformat.md
 
 # Open Badges API
 
@@ -982,11 +982,11 @@ When the request for revocation is rejected, the [=authorization server=] return
 
 
 
-@v3p0/spec/integrity.md
+@standards/v3p0/spec/integrity.md
 
-@v3p0/spec/verification.md
+@standards/v3p0/spec/verification.md
 
-@v3p0/spec/equality-and-comparison.md
+@standards/v3p0/spec/equality-and-comparison.md
 
 # Verifiable Credentials Extensions
 
@@ -1001,7 +1001,7 @@ This standard references four VC Extensions:
 > **Note**: The 1EdTech extensions are designed to work with any [=verifiable credential=] and may be contributed to the [[VC-EXTENSION-REGISTRY]] in the future.
 
 
-@v3p0/spec/serialization.md
+@standards/v3p0/spec/serialization.md
 
 # Data Models
 
@@ -1078,7 +1078,7 @@ title: Verification Support Data Models
 
 The data models in this section are used by the [[[#verification-and-validation]]] process for supporting older credentials created with [[VC-DATA-MODEL-1.1]].
 
-@v3p0/spec/extending.md
+@standards/v3p0/spec/extending.md
 
 # Examples
 
diff --git a/ob_v3p0/microsites/v3p0/cert.md b/ob_v3p0/microsites/v3p0/cert.md
@@ -198,14 +198,14 @@ releases:
     comments: Added JSON-LD Safe mode requirement for issuer certification profile.
 ---
 
-@v3p0/cert/abstract.md
+@standards/v3p0/cert/abstract.md
 
-@v3p0/cert/introduction.md
+@standards/v3p0/cert/introduction.md
 
-@v3p0/cert/conformance.md
+@standards/v3p0/cert/conformance.md
 
-@v3p0/cert/issuer.md
+@standards/v3p0/cert/issuer.md
 
-@v3p0/cert/displayer.md
+@standards/v3p0/cert/displayer.md
 
-@v3p0/cert/host.md
+@standards/v3p0/cert/host.md
diff --git a/ob_v3p0/microsites/v3p0/cert/abstract.md b/ob_v3p0/microsites/v3p0/cert/abstract.md
@@ -1,3 +1,12 @@
+---
+title: "Abstract"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Abstract for the Open Badges 3.0 certification document"
+---
+
 ## Abstract
 
 Open Badges are visual symbols of accomplishments packed with verifiable metadata according to the Open Badges specification. The Open Badges 3.0 specification [[OB-30]] defines the properties necessary to define an achievement and award it to a recipient, as well as procedures for verifying badge authenticity and “baking” badge information into portable image files. It includes term definitions for representations of data in Open Badges and defines an API for exchanging badge information. These term definitions appear in the current Open Badges JSON-LD Context File.
diff --git a/ob_v3p0/microsites/v3p0/cert/conformance.md b/ob_v3p0/microsites/v3p0/cert/conformance.md
@@ -1,3 +1,12 @@
+---
+title: "Conformance and Certification"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Overview of Open Badges 3.0 conformance and certification requirements"
+---
+
 ## Conformance and Certification
 
 The goal of 1EdTech certification for Open Badges [[OB-30]] is to ensure interoperable implementations of badging systems that generate and issue digital badges as well as those that host and display badges.
diff --git a/ob_v3p0/microsites/v3p0/cert/displayer.md b/ob_v3p0/microsites/v3p0/cert/displayer.md
@@ -1,3 +1,12 @@
+---
+title: "Open Badges 3.0 Displayer Service Conformance"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Displayer service conformance requirements for Open Badges 3.0 certification"
+---
+
 ## Open Badges 3.0 Displayer Service Conformance {#displayer-conformance}
 
 An Open Badges Displayer is an application that displays and verifies badges for viewers. The candidate platform must support viewer-initiated verification of a badge.
diff --git a/ob_v3p0/microsites/v3p0/cert/host.md b/ob_v3p0/microsites/v3p0/cert/host.md
@@ -1,3 +1,12 @@
+---
+title: "Open Badges 3.0 Host Service Conformance"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Host service conformance requirements for Open Badges 3.0 certification"
+---
+
 ## Open Badges 3.0 Host Service Conformance {#host-conformance}
 
 An Open Badges **Host** is an application that can aggregate and publicly host OpenBadgeCredential for recipients. It also supports export of badges at user request. The candidate platform must be able to import all formats of Open Badges as well as prove that badge metadata is not lost upon export of the badge. The candidate platform must also meet [[[#service-provider-write]]] requirements and accept an AchievementCredential or a Profile from an Issuer application. And meet [[[#service-consumer-read]]] and [[[#service-provider-read]]] requirements for exchanging AchievementCredentials with other Host applications.
diff --git a/ob_v3p0/microsites/v3p0/cert/introduction.md b/ob_v3p0/microsites/v3p0/cert/introduction.md
@@ -1,3 +1,12 @@
+---
+title: "Introduction"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Introduction for Open Badges 3.0 certification"
+---
+
 ## Introduction
 
 ### Conformance Statements {#conformance}
diff --git a/ob_v3p0/microsites/v3p0/cert/issuer.md b/ob_v3p0/microsites/v3p0/cert/issuer.md
@@ -1,3 +1,12 @@
+---
+title: "Open Badges 3.0 Issuer Service Conformance"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Issuer service conformance requirements for Open Badges 3.0 certification"
+---
+
 ## Open Badges 3.0 Issuer Service Conformance {#issuer-conformance}
 
 A Open Badges **Issuer** is an application that allows for the creation of OpenBadgeCredentials and the subsequent delivery of OpenBadgeCredentials to recipients that conform to the Open Badges Specification. The candidate platform must issue a valid badge and demonstrate how the badge is retrieved by the recipient. The candidate platform may also meet Service Consumer (Write) requirements and can send an AchievementCredential or a Profile to a product that conforms to Service Provider (Write) requirements.
diff --git a/ob_v3p0/microsites/v3p0/errata.md b/ob_v3p0/microsites/v3p0/errata.md
@@ -125,4 +125,4 @@ releases:
     comments: Fixed typography errors in the errata document.
 ---
 
-@v3p0/errata/errata.md
+@standards/v3p0/errata/errata.md
diff --git a/ob_v3p0/microsites/v3p0/errata/errata.md b/ob_v3p0/microsites/v3p0/errata/errata.md
@@ -1,3 +1,12 @@
+---
+title: "Errata for Open Badges 3.0 Specification"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Errata for the Open Badges 3.0 specification"
+---
+
 ## Errata for Open Badges 3.0 Specification
 
 ### Context file
diff --git a/ob_v3p0/microsites/v3p0/impl.md b/ob_v3p0/microsites/v3p0/impl.md
@@ -158,21 +158,21 @@ releases:
     comments: Fixed some typos.
 ---
 
-@v3p0/impl/introduction.md
+@standards/v3p0/impl/introduction.md
 
-@v3p0/impl/getting-started.md
+@standards/v3p0/impl/getting-started.md
 
-@v3p0/impl/recommended-practices.md
+@standards/v3p0/impl/recommended-practices.md
 
-@v3p0/impl/reference-impls.md
+@standards/v3p0/impl/reference-impls.md
 
-@v3p0/impl/conformance.md
+@standards/v3p0/impl/conformance.md
 
-@v3p0/impl/migrating.md
+@standards/v3p0/impl/migrating.md
 
-@v3p0/impl/extensions.md
+@standards/v3p0/impl/extensions.md
 
-@v3p0/impl/help.md
+@standards/v3p0/impl/help.md
 
 ## Linked Data Proof Test Vector for Open Badges 3.0
 
diff --git a/ob_v3p0/microsites/v3p0/impl/conformance.md b/ob_v3p0/microsites/v3p0/impl/conformance.md
@@ -1,3 +1,12 @@
+---
+title: "Conformance and Certification"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Conformance and certification for Open Badges 3.0 implementations"
+---
+
 ## Conformance and Certification{.informative}
 
 The [[OB-CERT-30]] covers the specific requirements that implementers must cover
diff --git a/ob_v3p0/microsites/v3p0/impl/extensions.md b/ob_v3p0/microsites/v3p0/impl/extensions.md
@@ -1,3 +1,12 @@
+---
+title: "Open Badges Extensions"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Open Badges 3.0 extensions"
+---
+
 ## Open Badges Extensions{#informative}
 
 [Open Badges 3.0](/ob/specifications/ob-v3p0#extending) and [Comprehensive Learner Record 2.0](http://www.imsglobal.org/spec/clr/v2p0#extending) allows extensibility in several ways: data model, extensible enumerated vocabularies and API.
diff --git a/ob_v3p0/microsites/v3p0/impl/getting-started.md b/ob_v3p0/microsites/v3p0/impl/getting-started.md
@@ -1,3 +1,12 @@
+---
+title: "Getting Started (for Developers)"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Getting started guide for Open Badges 3.0 developers"
+---
+
 ## Getting Started (for Developers){.informative}
 
 It may seem like an overwhelming task to implement Open Badges 3.0 or CLR 2.0,
diff --git a/ob_v3p0/microsites/v3p0/impl/help.md b/ob_v3p0/microsites/v3p0/impl/help.md
@@ -1,3 +1,12 @@
+---
+title: "Getting Help"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Getting help with Open Badges 3.0 implementations"
+---
+
 ## Getting Help{.informative}
 
 If you have questions or need help with implementing Open Badges 3.0 or
diff --git a/ob_v3p0/microsites/v3p0/impl/introduction.md b/ob_v3p0/microsites/v3p0/impl/introduction.md
@@ -1,3 +1,12 @@
+---
+title: "Introduction"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Introduction to the Open Badges 3.0 implementation guide"
+---
+
 ## Introduction
 
 The 1EdTech digital credentials specifications, Open Badges and Comprehensive
diff --git a/ob_v3p0/microsites/v3p0/impl/migrating.md b/ob_v3p0/microsites/v3p0/impl/migrating.md
@@ -1,3 +1,12 @@
+---
+title: "Migrating from OB 2.0, OB 2.1, and CLR 1.0"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Migration guide for Open Badges 3.0"
+---
+
 ## Migrating from OB 2.0, OB 2.1, and CLR 1.0{#informative}
 
 Open Badges 3.0 and Comprehensive Learner Record 2.0 are major releases, and
diff --git a/ob_v3p0/microsites/v3p0/impl/recommended-practices.md b/ob_v3p0/microsites/v3p0/impl/recommended-practices.md
@@ -1,3 +1,12 @@
+---
+title: "Recommended Practices"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Recommended practices for Open Badges 3.0 implementations"
+---
+
 ## Recommended Practices{.informative}
 
 Conformance certification ensures consistency across an important but focused
diff --git a/ob_v3p0/microsites/v3p0/impl/reference-impls.md b/ob_v3p0/microsites/v3p0/impl/reference-impls.md
@@ -1,3 +1,12 @@
+---
+title: "Using Reference Implementations"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Reference implementations for Open Badges 3.0"
+---
+
 ## Using Reference Implementations{.informative}
 
 The Reference Implementation is an 1EdTech implementation of Open Badges 3.0 and
diff --git a/ob_v3p0/microsites/v3p0/spec/abstract.md b/ob_v3p0/microsites/v3p0/spec/abstract.md
@@ -1,3 +1,12 @@
-# Abstract
+---
+title: "Abstract"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Abstract for the Open Badges 3.0 specification"
+---
+
+## Abstract
 
 This specification is a new version of the [1EdTech Open Badges Specification](https://www.imsglobal.org/activity/digital-badges) that aligns with the conventions of the [[VC-DATA-MODEL-2.0]] for the use cases of [=Defined Achievement Claim=] and a [=Skill Claim=]. The credentials that are produced are easily be bundled into [=Comprehensive Learner Records=] and [=Verifiable Presentations=]. Portability and learner data privacy are improved by expanding the usage of cryptographic proofs/signatures, because this format will be compatible with a growing array of proof schemas that are developed for the Verifiable Credentials Data Model.
diff --git a/ob_v3p0/microsites/v3p0/spec/docformat.md b/ob_v3p0/microsites/v3p0/spec/docformat.md
@@ -1,4 +1,13 @@
-# Open Badges Document Formats {#docformat}
+---
+title: "Open Badges Document Formats"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Document formats for Open Badges 3.0 credentials"
+---
+
+## Open Badges Document Formats {#docformat}
 
 [OpenBadgeCredentials](#org.1edtech.ob.v3p0.achievementcredential.class) can be exchanged as documents as defined in this section, or by using the [Open Badges API](#api). Documents can be exchanged as a text file, a web resource, or embedded in an image. The contents of an Open Badge document MUST meet the following criteria:
 
diff --git a/ob_v3p0/microsites/v3p0/spec/equality-and-comparison.md b/ob_v3p0/microsites/v3p0/spec/equality-and-comparison.md
@@ -1,4 +1,13 @@
-# Credential equality and comparison algorithm{#credential-equality-and-comparison}
+---
+title: "Credential equality and comparison algorithm"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Credential equality and comparison for Open Badges 3.0"
+---
+
+## Credential equality and comparison algorithm{#credential-equality-and-comparison}
 
 Credential equality and comparison is the process to determine whether a [=verifiable credential=] is semantically equivalent to another one.
 
diff --git a/ob_v3p0/microsites/v3p0/spec/extending.md b/ob_v3p0/microsites/v3p0/spec/extending.md
@@ -1,3 +1,12 @@
+---
+title: "Extending and Profiling the Standard"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Extending and profiling the Open Badges 3.0 standard"
+---
+
 ## Extending and Profiling the Standard {#extending}
 
 This standard can be extended in three ways:
diff --git a/ob_v3p0/microsites/v3p0/spec/gettingstarted.md b/ob_v3p0/microsites/v3p0/spec/gettingstarted.md
@@ -1,4 +1,13 @@
-# Getting Started
+---
+title: "Getting Started"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Getting started with the Open Badges 3.0 specification"
+---
+
+## Getting Started
 
 ## Implementation Guide
 
diff --git a/ob_v3p0/microsites/v3p0/spec/integrity.md b/ob_v3p0/microsites/v3p0/spec/integrity.md
@@ -1,4 +1,13 @@
-# Proofs (Signatures) {#data-integrity}
+---
+title: "Proofs (Signatures)"
+docType: "segment"
+status: "Final"
+author: "1Edtech Consortium"
+lastUpdated: 2023-08-10
+description: "Data integrity proofs and signatures for Open Badges 3.0"
+---
+
+## Proofs (Signatures) {#data-integrity}
 
 This section describes mechanisms for ensuring the authenticity and integrity of OpenBadgeCredentials. At least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a [=credential=] to be a [=verifiable credential=]; that is, to be [=verifiable=]. In order to pass 1EdTech conformance tests, issuers MUST use a proof mechanism supported by the 1EdTech conformance test suite. See more about [Selecting proof methods and crypto algorithms](impl#selecting-proof-methods-and-crypto-algorithms) in the Implementation Guide.
 
diff --git a/ob_v3p0/microsites/v3p0/spec/introduction.md b/ob_v3p0/microsites/v3p0/spec/introduction.md
diff --git a/ob_v3p0/microsites/v3p0/spec/overview.md b/ob_v3p0/microsites/v3p0/spec/overview.md
diff --git a/ob_v3p0/microsites/v3p0/spec/serialization.md b/ob_v3p0/microsites/v3p0/spec/serialization.md
diff --git a/ob_v3p0/microsites/v3p0/spec/usecases.md b/ob_v3p0/microsites/v3p0/spec/usecases.md
diff --git a/ob_v3p0/microsites/v3p0/spec/verification.md b/ob_v3p0/microsites/v3p0/spec/verification.md
