Documentation Package Manifest Specification
Official schema for docs.manifest.ygit documentation package manifests.
Overview
- Schema
- DPMS
- Version
- v1.0.0
- Draft
- 2020-12
- License
- MIT
- Compatibility
- DPMS v1
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| $schema | string (URI) | Yes | Canonical DPMS Version 1 schema URL. |
| schemaVersion | integer | Yes | Schema major version; must equal 1. |
| manifestVersion | string (SemVer) | Yes | DPMS Version 1 manifest format version. |
| documentation | object | Yes | Documentation package identity, title, root directory, and default document. |
| discovery | object | Yes | Automatic discovery rules, file patterns, and extension filters. |
| structure | object | Yes | Documentation logical structure, sections, navigation order, and hierarchy. |
| versions | object | No | Documentation multi-versioning, version list, and release strategy. |
| custom | object | No | Vendor-specific and platform extensions. |
Example
Minimal docs.manifest.ygit
{
"$schema": "https://schema.ygit.dev/dpms/v1/docs.manifest.schema.json",
"schemaVersion": 1,
"manifestVersion": "1.0.0",
"documentation": {
"id": "vib-tools-image-converter",
"title": "Vib Tools Image Converter Documentation",
"description": "Official user documentation for Vib Tools Image Converter.",
"docsRoot": "docs/",
"defaultDocument": "getting-started/introduction.md",
"defaultLanguage": "en",
"status": "published",
"tags": [
"image",
"converter",
"desktop",
"windows"
]
},
"discovery": {
"enabled": true,
"recursive": true,
"include": [
"**/*.md"
],
"exclude": [
"assets/**",
"images/**",
"drafts/**"
],
"extensions": [
"md"
],
"ignoreHidden": true,
"followSymlink": false
},
"structure": {
"autoGenerate": true,
"sort": "manual",
"maxDepth": 10,
"sections": [
{
"id": "getting-started",
"title": "Getting Started",
"description": "Initial setup and first steps.",
"icon": "rocket",
"path": "getting-started/",
"order": 1,
"hidden": false,
"collapsed": false
}
]
}
}Downloads
Use the immutable DPMS Version 1 URL in manifests and automation.