From 768cf9ee1875dc5d7eca4301e88e47683b05a43b Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Fri, 19 Sep 2025 13:39:38 -0700 Subject: [PATCH 1/5] Deprecate old Node lib, add new one --- .gitignore | 1 + docs/nodejs.md | 10 ++++++++ scripts/fetch-readme.js | 21 +++------------- sidebars.js | 55 ++++++++++++++++++++++++----------------- 4 files changed, 47 insertions(+), 40 deletions(-) create mode 100644 docs/nodejs.md diff --git a/.gitignore b/.gitignore index f77c4dd..a0462bc 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,7 @@ /docs/c2patool/*.md /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 diff --git a/docs/nodejs.md b/docs/nodejs.md new file mode 100644 index 0000000..709b7e6 --- /dev/null +++ b/docs/nodejs.md @@ -0,0 +1,10 @@ +--- +id: node-landing +title: Node.js library +--- + +**Sept 2025**: A new Node.js library has been released. You can continue to use the old library, but the old library is deprecated and you're encouraged to move to the new one as soon as possible. + +:::note +You can continue to [install and use the old library](c2pa-node/readme.md) the same as before, but it will no longer be updated or supported. +::: \ No newline at end of file diff --git a/scripts/fetch-readme.js b/scripts/fetch-readme.js index 6c34dcf..b0a69b0 100644 --- a/scripts/fetch-readme.js +++ b/scripts/fetch-readme.js @@ -107,30 +107,15 @@ const readmes = [ }, // Node.js lib { - dest: resolve(__dirname, '../docs/c2pa-node/readme.md'), - repo: 'contentauth/c2pa-node', + dest: resolve(__dirname, '../docs/c2pa-node-v2/readme.md'), + repo: 'contentauth/c2pa-node-v2', path: 'README.md', }, { - dest: resolve(__dirname, '../docs/c2pa-node/docs/usage.md'), - repo: 'contentauth/c2pa-node', - path: 'docs/usage.md', - }, - { - dest: resolve(__dirname, '../docs/c2pa-node/docs/supported-formats.md'), + dest: resolve(__dirname, '../docs/c2pa-node-v2/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'), diff --git a/sidebars.js b/sidebars.js index 068c9d3..27485e0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -152,33 +152,44 @@ const sidebars = { { type: 'category', label: 'Node.js', - link: { type: 'doc', id: 'c2pa-node/readme' }, + link: { type: 'doc', id: 'node-landing' }, collapsed: true, items: [ { - 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: 'category', + label: 'New Node.js library', + link: { type: 'doc', id: 'c2pa-node-v2/readme' }, + collapsed: true, + items: [ + { + type: 'doc', + id: 'c2pa-node-v2/supported-formats', + label: 'Supported media formats', + }, + { + type: 'link', + label: 'API documentation', + href: 'https://github.com/contentauth/c2pa-node-v2/blob/main/docs/README.md', + }, + { + type: 'link', + label: 'GitHub', + href: 'https://github.com/contentauth/c2pa-node-v2/tree/main', + }, + ], }, { - type: 'doc', - label: 'C2PA Node example', - id: 'c2pa-node-example/readme', - }, - { - type: 'link', - label: 'GitHub', - href: 'https://github.com/contentauth/c2pa-node', + type: 'category', + label: 'Legacy Node.js library', + link: { type: 'doc', id: 'c2pa-node/readme' }, + collapsed: true, + items: [ + { + type: 'link', + label: 'GitHub', + href: 'https://github.com/contentauth/c2pa-node', + }, + ], }, ], }, From 9c95a9be0926fbaee9430ed8d86c20aa433e1a6c Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Fri, 19 Sep 2025 13:45:06 -0700 Subject: [PATCH 2/5] Add c2pa-node-v2 dir with .gitkeep --- c2pa-node-v2/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 c2pa-node-v2/.gitkeep diff --git a/c2pa-node-v2/.gitkeep b/c2pa-node-v2/.gitkeep new file mode 100644 index 0000000..e69de29 From 9321a8522279e13e27dacd924a65b61bb1610d5b Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Fri, 19 Sep 2025 13:50:02 -0700 Subject: [PATCH 3/5] add missing dir --- docs/c2pa-node-v2/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/c2pa-node-v2/.gitkeep diff --git a/docs/c2pa-node-v2/.gitkeep b/docs/c2pa-node-v2/.gitkeep new file mode 100644 index 0000000..e69de29 From 06ea5a72eaf1d74b082bac8fb1a39e8de86bc57d Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Fri, 19 Sep 2025 14:01:24 -0700 Subject: [PATCH 4/5] Old node readme --- docs/c2pa-node/docs/.gitkeep | 0 scripts/fetch-readme.js | 6 ++++++ 2 files changed, 6 insertions(+) delete mode 100644 docs/c2pa-node/docs/.gitkeep diff --git a/docs/c2pa-node/docs/.gitkeep b/docs/c2pa-node/docs/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/scripts/fetch-readme.js b/scripts/fetch-readme.js index b0a69b0..ca5c9f8 100644 --- a/scripts/fetch-readme.js +++ b/scripts/fetch-readme.js @@ -105,6 +105,12 @@ const readmes = [ repo: 'contentauth/c2pa-service-example', path: 'README.md', }, + // Old Node.js lib + { + dest: resolve(__dirname, '../docs/c2pa-node/readme.md'), + repo: 'contentauth/c2pa-node', + path: 'README.md', + }, // Node.js lib { dest: resolve(__dirname, '../docs/c2pa-node-v2/readme.md'), From 95cfc1953c46954d3c45de7b67f5e05b45bfa196 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Fri, 19 Sep 2025 14:11:21 -0700 Subject: [PATCH 5/5] docs apology --- docs/nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/nodejs.md b/docs/nodejs.md index 709b7e6..870a6e0 100644 --- a/docs/nodejs.md +++ b/docs/nodejs.md @@ -3,7 +3,7 @@ id: node-landing title: Node.js library --- -**Sept 2025**: A new Node.js library has been released. You can continue to use the old library, but the old library is deprecated and you're encouraged to move to the new one as soon as possible. +**Sept 2025**: A new Node.js library has been released. We are working on adding documentation for the new library. Please bear with us! :::note You can continue to [install and use the old library](c2pa-node/readme.md) the same as before, but it will no longer be updated or supported.