Incorporate repo doc reorgs into docs

.gitignore

@@ -8,8 +8,17 @@
 .docusaurus
 .cache-loader
 /docs/js-sdk/api
-/docs/c2patool
-/docs/rust-sdk
+/docs/c2patool/*.md
+/docs/c2patool/docs/*.md
+/docs/c2pa-node/*.md
+/docs/c2pa-node-example/*.md
+/docs/c2pa-node/docs/*.md
+/docs/c2pa-python/*.md
+/docs/c2pa-python/docs/*.md
+/docs/c2pa-c/*.md
+/docs/c2pa-c/docs/*.md
+/docs/rust-sdk/*.md
+/docs/rust-sdk/docs/*.md
 /docs/**/readme.md
 
 # Misc

scripts/fetch-readme.js

@@ -19,66 +19,138 @@ $ touch .gitkeep
 */
 
 const readmes = [
-  {
-    dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
-    repo: 'contentauth/c2pa-rs',
-    path: 'README.md',
-  },
-  {
-    dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
-    repo: 'contentauth/c2pa-min',
-    path: 'README.md',
-  },
+  // c2patool
   {
     dest: resolve(__dirname, '../docs/c2patool/readme.md'),
     repo: 'contentauth/c2patool',
     path: 'README.md',
   },
   {
-    dest: resolve(__dirname, '../docs/c2patool/manifest.md'),
+    dest: resolve(__dirname, '../docs/c2patool/docs/manifest.md'),
     repo: 'contentauth/c2patool',
     path: 'docs/manifest.md',
   },
   {
-    dest: resolve(__dirname, '../docs/c2patool/x_509.md'),
+    dest: resolve(__dirname, '../docs/c2patool/docs/x_509.md'),
     repo: 'contentauth/c2patool',
     path: 'docs/x_509.md',
   },
   {
-    dest: resolve(__dirname, '../docs/c2patool/release-notes.md'),
+    dest: resolve(__dirname, '../docs/c2patool/docs/release-notes.md'),
     repo: 'contentauth/c2patool',
     path: 'docs/release-notes.md',
   },
+  /* Waiting for https://github.com/contentauth/c2patool/pull/296 
+  {
+    dest: resolve(__dirname, '../docs/c2patool/docs/usage.md'),
+    repo: 'contentauth/c2patool',
+    path: 'docs/usage.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2patool/docs/supported-formats.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/supported-formats.md',
+  },
+  */
   {
     dest: resolve(__dirname, '../docs/c2pa-service-example/readme.md'),
     repo: 'contentauth/c2pa-service-example',
     path: 'README.md',
   },
+  // Node.js lib
   {
-    dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
-    repo: 'contentauth/c2pa-c',
+    dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
+    repo: 'contentauth/c2pa-node',
     path: 'README.md',
   },
   {
-    dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
+    dest: resolve(__dirname, '../docs/c2pa-node/docs/usage.md'),
     repo: 'contentauth/c2pa-node',
-    path: 'README.md',
+    path: 'docs/usage.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-node/docs/supported-formats.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/supported-formats.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-node/docs/release-notes.md'),
+    repo: 'contentauth/c2pa-node',
+    path: 'docs/release-notes.md',
   },
   {
     dest: resolve(__dirname, '../docs/c2pa-node-example/readme.md'),
     repo: 'contentauth/c2pa-node-example',
     path: 'README.md',
   },
+  // Python lib
   {
     dest: resolve(__dirname, '../docs/c2pa-python/readme.md'),
     repo: 'contentauth/c2pa-python',
     path: 'README.md',
   },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-python/docs/usage.md'),
+    repo: 'contentauth/c2pa-python',
+    path: 'docs/usage.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-python/docs/supported-formats.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/supported-formats.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-python/docs/release-notes.md'),
+    repo: 'contentauth/c2pa-python',
+    path: 'docs/release-notes.md',
+  },
   {
     dest: resolve(__dirname, '../docs/c2pa-python-example/readme.md'),
     repo: 'contentauth/c2pa-python-example',
     path: 'README.md',
   },
+  // C lib
+  {
+    dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
+    repo: 'contentauth/c2pa-c',
+    path: 'README.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-c/docs/usage.md'),
+    repo: 'contentauth/c2pa-c',
+    path: 'docs/usage.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-c/docs/supported-formats.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/supported-formats.md',
+  },
+  // Rust lib
+  {
+    dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'README.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/rust-sdk/docs/supported-formats.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/supported-formats.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/rust-sdk/docs/usage.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/usage.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/rust-sdk/docs/release-notes.md'),
+    repo: 'contentauth/c2pa-rs',
+    path: 'docs/release-notes.md',
+  },
+  {
+    dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
+    repo: 'contentauth/c2pa-min',
+    path: 'README.md',
+  },
 ];
 
 function resolveMarkdownLinks(linkBase, content) {
@@ -101,8 +173,9 @@ async function download() {
     const linkBase = `${GITHUB_HOST}/${repo}/blob/${branch}/${path}`;
     const res = await fetch(src);
     const markdown = await res.text();
-    const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
-    await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
+    //const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
+    //await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
+    await writeFile(dest, markdown, { encoding: 'utf-8', flag: 'w+' });
     console.log('Saved %s to %s', src, dest);
   }
 }

scripts/generate-api-docs/index.js

@@ -72,7 +72,7 @@ function appendStringToFiles(directory, stringToAppend) {
             return;
           }
 
-          console.log(`Appended "${stringToAppend}" to ${file}`);
+          //console.log(`Appended "${stringToAppend}" to ${file}`);
         });
       });
     });

sidebars.js

@@ -67,19 +67,37 @@ const sidebars = {
       link: { type: 'doc', id: 'c2patool/readme' },
       collapsed: true,
       items: [
+        /* Waiting for https://github.com/contentauth/c2patool/pull/296        
         {
           type: 'doc',
-          id: 'c2patool/manifest',
+          id: 'c2patool/docs/usage',
+          label: 'Using C2PA Tool',
+        },
+        {
+          type: 'doc',
+          id: 'c2patool/docs/supported-formats',
+          label: 'Supported media formats',
+        },
+*/
+        {
+          type: 'doc',
+          id: 'c2patool/docs/manifest',
           label: 'Using a manifest file',
         },
         {
           type: 'doc',
-          id: 'c2patool/x_509',
-          label: 'Creating and using a certificate',
+          id: 'c2patool/docs/x_509',
+          label: 'Using a certificate',
+        },
+        {
+          type: 'doc',
+          id: 'c2patool/docs/release-notes',
+          label: 'Release notes',
         },
         {
           type: 'doc',
           id: 'c2pa-service-example/readme',
+          label: 'C2PA Tool service example',
         },
         {
           type: 'link',
@@ -109,14 +127,30 @@ const sidebars = {
           collapsed: true,
           items: [
             {
-              type: 'link',
-              label: 'GitHub',
-              href: 'https://github.com/contentauth/c2pa-node',
+              type: 'doc',
+              id: 'c2pa-node/docs/usage',
+              label: 'Using the Node library',
+            },
+            {
+              type: 'doc',
+              id: 'c2pa-node/docs/supported-formats',
+              label: 'Supported media formats',
             },
             {
               type: 'doc',
+              id: 'c2pa-node/docs/release-notes',
+              label: 'Release notes',
+            },
+            {
+              type: 'doc',
+              label: 'C2PA Node example',
               id: 'c2pa-node-example/readme',
             },
+            {
+              type: 'link',
+              label: 'GitHub',
+              href: 'https://github.com/contentauth/c2pa-node',
+            },
           ],
         },
         {
@@ -126,14 +160,29 @@ const sidebars = {
           collapsed: true,
           items: [
             {
-              type: 'link',
-              label: 'GitHub',
-              href: 'https://github.com/contentauth/c2pa-python',
+              type: 'doc',
+              id: 'c2pa-python/docs/usage',
+              label: 'Using the Python library',
+            },
+            {
+              type: 'doc',
+              id: 'c2pa-python/docs/supported-formats',
+              label: 'Supported media formats',
+            },
+            {
+              type: 'doc',
+              id: 'c2pa-python/docs/release-notes',
+              label: 'Release notes',
             },
             {
               type: 'doc',
-              label: 'C2PA Python Example',
               id: 'c2pa-python-example/readme',
+              label: 'C2PA Python example',
+            },
+            {
+              type: 'link',
+              label: 'GitHub',
+              href: 'https://github.com/contentauth/c2pa-python',
             },
           ],
         },
@@ -143,6 +192,16 @@ const sidebars = {
           link: { type: 'doc', id: 'c2pa-c/readme' },
           collapsed: true,
           items: [
+            {
+              type: 'doc',
+              id: 'c2pa-c/docs/usage',
+              label: 'Using the C++ library',
+            },
+            {
+              type: 'doc',
+              id: 'c2pa-c/docs/supported-formats',
+              label: 'Supported media formats',
+            },
             {
               type: 'link',
               label: 'GitHub',
@@ -159,21 +218,36 @@ const sidebars = {
       link: { type: 'doc', id: 'rust-sdk/readme' },
       collapsed: true,
       items: [
+        {
+          type: 'doc',
+          id: 'rust-sdk/docs/usage',
+          label: 'Using the Rust library',
+        },
+        {
+          type: 'doc',
+          id: 'rust-sdk/docs/supported-formats',
+          label: 'Supported media formats',
+        },
+        {
+          type: 'doc',
+          id: 'rust-sdk/docs/release-notes',
+          label: 'Release notes',
+        },
         {
           type: 'link',
           label: 'API documentation',
           href: 'https://docs.rs/c2pa',
         },
+        {
+          type: 'doc',
+          id: 'c2pa-min/readme',
+          label: 'C2PA Rust example application',
+        },
         {
           type: 'link',
           label: 'GitHub',
           href: 'https://github.com/contentauth/c2pa-rs',
         },
-        {
-          type: 'doc',
-          label: 'C2PA Rust example application',
-          id: 'c2pa-min/readme',
-        },
       ],
     },
     {