docs: fix category metadata validation in documentation

youngjungithub · youngjungithub · commit 8eb95c071182 · 2025-03-18T15:47:14.000-04:00
- Remove invalid documentation_type field from category configs
- Update category descriptions per Diátaxis framework
- Fix Tutorials/How-Tos/Reference/Explanation categories
- Align with Docusaurus schema requirements
diff --git a/website/docs/explanation/_category_.json b/website/docs/explanation/_category_.json
@@ -1,9 +1,8 @@
 {
   "label": "Explanation",
-  "documentation_type": "explanation",
   "position": 5,
   "link": {
     "type": "generated-index",
-    "description": "Conceptual guides explaining api-ts architecture and design decisions."
+    "description": "Conceptual guides understanding API design philosophy"
   }
 }
diff --git a/website/docs/how-to-guides/_category_.json b/website/docs/how-to-guides/_category_.json
@@ -1,6 +1,5 @@
 {
   "label": "How-To Guides",
-  "documentation_type": "how-to_guide",
   "position": 3,
   "link": {
     "type": "generated-index",
diff --git a/website/docs/reference/_category_.json b/website/docs/reference/_category_.json
@@ -1,9 +1,8 @@
 {
   "label": "Reference",
-  "documentation_type": "reference",
   "position": 4,
   "link": {
     "type": "generated-index",
-    "description": "Technical reference documentation for api-ts components"
+    "description": "Technical specifications and API reference documentation"
   }
 }
diff --git a/website/docs/tutorial-basics/_category_.json b/website/docs/tutorial-basics/_category_.json
@@ -1,9 +1,8 @@
 {
   "label": "Tutorial - Basics",
-  "documentation_type": "tutorial",
   "position": 2,
   "link": {
     "type": "generated-index",
-    "description": "5 minutes to learn the most important api-ts concepts."
+    "description": "Hands-on learning experiences for API specification fundamentals"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Explanation",`
`3`		`- "documentation_type": "explanation",`
`4`	`3`	`"position": 5,`
`5`	`4`	`"link": {`
`6`	`5`	`"type": "generated-index",`
`7`		`- "description": "Conceptual guides explaining api-ts architecture and design decisions."`
	`6`	`+ "description": "Conceptual guides understanding API design philosophy"`
`8`	`7`	`}`
`9`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "How-To Guides",`
`3`		`- "documentation_type": "how-to_guide",`
`4`	`3`	`"position": 3,`
`5`	`4`	`"link": {`
`6`	`5`	`"type": "generated-index",`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Reference",`
`3`		`- "documentation_type": "reference",`
`4`	`3`	`"position": 4,`
`5`	`4`	`"link": {`
`6`	`5`	`"type": "generated-index",`
`7`		`- "description": "Technical reference documentation for api-ts components"`
	`6`	`+ "description": "Technical specifications and API reference documentation"`
`8`	`7`	`}`
`9`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Tutorial - Basics",`
`3`		`- "documentation_type": "tutorial",`
`4`	`3`	`"position": 2,`
`5`	`4`	`"link": {`
`6`	`5`	`"type": "generated-index",`
`7`		`- "description": "5 minutes to learn the most important api-ts concepts."`
	`6`	`+ "description": "Hands-on learning experiences for API specification fundamentals"`
`8`	`7`	`}`
`9`	`8`	`}`