Add schemas and poc doc using docusaurus-json-schema-plugin

.gitignore

@@ -19,7 +19,6 @@
 /docs/c2patool/docs/*.md
 /docs/c2pa-node/*.md
 /docs/c2pa-node-v2/*.md
-/docs/c2pa-node-example/*.md
 /docs/c2pa-node/docs/*.md
 /docs/c2pa-python/*.md
 /docs/c2pa-python/docs/*.md

cargo/README.md

@@ -1,4 +1,4 @@
-# Cargo <-> Dependabot integration
+# Cargo / Dependabot integration
 
 This directory exists so that we can have a Cargo.toml file that Dependabot can track for updates to our Rust projects:
 

docs/mobile.md

@@ -8,6 +8,7 @@ These projects have recently graduated from "incubator" status, but are still un
 :::
 
 These projects are available to enable developing apps for mobile devices:
+
 - [**iOS Library**](/c2pa-ios/README.md): Provides iOS/macOS support via Swift Package/XCFramework.  <br/>GitHub repository: https://github.com/contentauth/c2pa-ios.
 - [**Android Library**](c2pa-android/README.md): Provides native Android support via an AAR library. <br/>GitHub repository: https://github.com/contentauth/c2pa-android.
 

docs/schemas/builder-schema.mdx

@@ -0,0 +1,7 @@
+import CodeBlock from '@theme/CodeBlock';
+import Schema from '@site/static/schemas/Builder.schema.json';
+import JSONSchemaViewer from '@theme/JSONSchemaViewer';
+
+# Builder schema
+
+<JSONSchemaViewer schema={Schema} />

docs/schemas/index.md

@@ -0,0 +1,13 @@
+---
+id: schemas-poc
+title: PoC of schema doc using docusaurus-json-schema-plugin
+---
+
+:::warning
+These are generated using an old version of docusaurus-json-schema-plugin.
+:::
+
+- [Builder schema](builder-schema.mdx)
+- [ManifestDefinition schema](manifest-def-schema.mdx)
+- [Reader schema](reader-schema.mdx)
+- [Settings schema](settings-schema.mdx)

docs/schemas/manifest-def-schema.mdx

@@ -0,0 +1,7 @@
+import CodeBlock from '@theme/CodeBlock';
+import Schema from '@site/static/schemas/ManifestDefinition.schema.json';
+import JSONSchemaViewer from '@theme/JSONSchemaViewer';
+
+# ManifestDefinition schema
+
+<JSONSchemaViewer schema={Schema} />

docs/schemas/reader-schema.mdx

@@ -0,0 +1,7 @@
+import CodeBlock from '@theme/CodeBlock';
+import Schema from '@site/static/schemas/Reader.schema.json';
+import JSONSchemaViewer from '@theme/JSONSchemaViewer';
+
+# Reader schema
+
+<JSONSchemaViewer schema={Schema} />

docs/schemas/settings-schema.mdx

@@ -0,0 +1,7 @@
+import CodeBlock from '@theme/CodeBlock';
+import Schema from '@site/static/schemas/Settings.schema.json';
+import JSONSchemaViewer from '@theme/JSONSchemaViewer';
+
+# Settings schema
+
+<JSONSchemaViewer schema={Schema} />

docusaurus.config.js

@@ -21,19 +21,14 @@ const externalRepos = {
   'c2pa-c': { repo: 'c2pa-c', path: '', org: 'contentauth' },
   'c2pa-min': { repo: 'c2pa-min', path: '', org: 'contentauth' },
   'c2pa-node': { repo: 'c2pa-node', path: '', org: 'contentauth' },
-  'c2pa-node-example': {
-    repo: 'c2pa-node-example',
-    path: '',
-    org: 'contentauth',
-  },
   'c2pa-python': { repo: 'c2pa-python', path: '', org: 'contentauth' },
   'c2pa-python-example': {
     repo: 'c2pa-python-example',
     path: '',
     org: 'contentauth',
   },
-  'c2pa-service-example': {
-    repo: 'c2pa-service-example',
+  'c2patool-service-example': {
+    repo: 'c2patool-service-example',
     path: '',
     org: 'contentauth',
   },

package.json

@@ -15,8 +15,7 @@
     "write-heading-ids": "docusaurus write-heading-ids",
     "prepare": "husky install",
     "prettier": "prettier --ignore-unknown --write .",
-    "docs:fetch-readme": "node scripts/fetch-readme.js",
-    "docs:generate-api-docs": "node scripts/generate-api-docs/index.js"
+    "docs:fetch-readme": "node scripts/fetch-readme.js"
   },
   "dependencies": {
     "@contentauth/react": "^0.2.38",
@@ -27,7 +26,7 @@
     "c2pa": "^0.30.16",
     "c2pa-wc": "^0.14.16",
     "clsx": "^1.1.1",
-    "docusaurus-json-schema-plugin": "^1.6.1",
+    "docusaurus-json-schema-plugin": "^1.13.0",
     "prism-react-renderer": "^2.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",