Skip to content

Commit d0bce6d

Browse files
crandmckcrandmck
authored
Merge pull request #178 from contentauth/repo-doc-reorgs
Incorporate repo doc reorgs into docs
2 parents 00f2999 + bbc41a2 commit d0bce6d

File tree

9 files changed

+193
-37
lines changed

9 files changed

+193
-37
lines changed

‎.gitignore‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,17 @@
88
.docusaurus
99
.cache-loader
1010
/docs/js-sdk/api
11-
/docs/c2patool
12-
/docs/rust-sdk
11+
/docs/c2patool/*.md
12+
/docs/c2patool/docs/*.md
13+
/docs/c2pa-node/*.md
14+
/docs/c2pa-node-example/*.md
15+
/docs/c2pa-node/docs/*.md
16+
/docs/c2pa-python/*.md
17+
/docs/c2pa-python/docs/*.md
18+
/docs/c2pa-c/*.md
19+
/docs/c2pa-c/docs/*.md
20+
/docs/rust-sdk/*.md
21+
/docs/rust-sdk/docs/*.md
1322
/docs/**/readme.md
1423

1524
# Misc

‎docs/c2pa-c/.gitkeep‎ renamed to ‎docs/c2pa-c/docs/.gitkeep‎

File renamed without changes.

‎docs/c2pa-python/.gitkeep‎ renamed to ‎docs/c2pa-node/docs/.gitkeep‎

File renamed without changes.

‎docs/c2patool/.gitkeep‎ renamed to ‎docs/c2pa-python/docs/.gitkeep‎

File renamed without changes.

‎docs/rust-sdk/.gitkeep‎ renamed to ‎docs/c2patool/docs/.gitkeep‎

File renamed without changes.

‎docs/rust-sdk/docs/.gitkeep‎

Whitespace-only changes.

‎scripts/fetch-readme.js‎

Lines changed: 92 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,66 +19,138 @@ $ touch .gitkeep
1919
*/
2020

2121
const readmes = [
22-
{
23-
dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
24-
repo: 'contentauth/c2pa-rs',
25-
path: 'README.md',
26-
},
27-
{
28-
dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
29-
repo: 'contentauth/c2pa-min',
30-
path: 'README.md',
31-
},
22+
// c2patool
3223
{
3324
dest: resolve(__dirname, '../docs/c2patool/readme.md'),
3425
repo: 'contentauth/c2patool',
3526
path: 'README.md',
3627
},
3728
{
38-
dest: resolve(__dirname, '../docs/c2patool/manifest.md'),
29+
dest: resolve(__dirname, '../docs/c2patool/docs/manifest.md'),
3930
repo: 'contentauth/c2patool',
4031
path: 'docs/manifest.md',
4132
},
4233
{
43-
dest: resolve(__dirname, '../docs/c2patool/x_509.md'),
34+
dest: resolve(__dirname, '../docs/c2patool/docs/x_509.md'),
4435
repo: 'contentauth/c2patool',
4536
path: 'docs/x_509.md',
4637
},
4738
{
48-
dest: resolve(__dirname, '../docs/c2patool/release-notes.md'),
39+
dest: resolve(__dirname, '../docs/c2patool/docs/release-notes.md'),
4940
repo: 'contentauth/c2patool',
5041
path: 'docs/release-notes.md',
5142
},
43+
/* Waiting for https://github.com/contentauth/c2patool/pull/296
44+
{
45+
dest: resolve(__dirname, '../docs/c2patool/docs/usage.md'),
46+
repo: 'contentauth/c2patool',
47+
path: 'docs/usage.md',
48+
},
49+
{
50+
dest: resolve(__dirname, '../docs/c2patool/docs/supported-formats.md'),
51+
repo: 'contentauth/c2pa-rs',
52+
path: 'docs/supported-formats.md',
53+
},
54+
*/
5255
{
5356
dest: resolve(__dirname, '../docs/c2pa-service-example/readme.md'),
5457
repo: 'contentauth/c2pa-service-example',
5558
path: 'README.md',
5659
},
60+
// Node.js lib
5761
{
58-
dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
59-
repo: 'contentauth/c2pa-c',
62+
dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
63+
repo: 'contentauth/c2pa-node',
6064
path: 'README.md',
6165
},
6266
{
63-
dest: resolve(__dirname, '../docs/c2pa-node/readme.md'),
67+
dest: resolve(__dirname, '../docs/c2pa-node/docs/usage.md'),
6468
repo: 'contentauth/c2pa-node',
65-
path: 'README.md',
69+
path: 'docs/usage.md',
70+
},
71+
{
72+
dest: resolve(__dirname, '../docs/c2pa-node/docs/supported-formats.md'),
73+
repo: 'contentauth/c2pa-rs',
74+
path: 'docs/supported-formats.md',
75+
},
76+
{
77+
dest: resolve(__dirname, '../docs/c2pa-node/docs/release-notes.md'),
78+
repo: 'contentauth/c2pa-node',
79+
path: 'docs/release-notes.md',
6680
},
6781
{
6882
dest: resolve(__dirname, '../docs/c2pa-node-example/readme.md'),
6983
repo: 'contentauth/c2pa-node-example',
7084
path: 'README.md',
7185
},
86+
// Python lib
7287
{
7388
dest: resolve(__dirname, '../docs/c2pa-python/readme.md'),
7489
repo: 'contentauth/c2pa-python',
7590
path: 'README.md',
7691
},
92+
{
93+
dest: resolve(__dirname, '../docs/c2pa-python/docs/usage.md'),
94+
repo: 'contentauth/c2pa-python',
95+
path: 'docs/usage.md',
96+
},
97+
{
98+
dest: resolve(__dirname, '../docs/c2pa-python/docs/supported-formats.md'),
99+
repo: 'contentauth/c2pa-rs',
100+
path: 'docs/supported-formats.md',
101+
},
102+
{
103+
dest: resolve(__dirname, '../docs/c2pa-python/docs/release-notes.md'),
104+
repo: 'contentauth/c2pa-python',
105+
path: 'docs/release-notes.md',
106+
},
77107
{
78108
dest: resolve(__dirname, '../docs/c2pa-python-example/readme.md'),
79109
repo: 'contentauth/c2pa-python-example',
80110
path: 'README.md',
81111
},
112+
// C lib
113+
{
114+
dest: resolve(__dirname, '../docs/c2pa-c/readme.md'),
115+
repo: 'contentauth/c2pa-c',
116+
path: 'README.md',
117+
},
118+
{
119+
dest: resolve(__dirname, '../docs/c2pa-c/docs/usage.md'),
120+
repo: 'contentauth/c2pa-c',
121+
path: 'docs/usage.md',
122+
},
123+
{
124+
dest: resolve(__dirname, '../docs/c2pa-c/docs/supported-formats.md'),
125+
repo: 'contentauth/c2pa-rs',
126+
path: 'docs/supported-formats.md',
127+
},
128+
// Rust lib
129+
{
130+
dest: resolve(__dirname, '../docs/rust-sdk/readme.md'),
131+
repo: 'contentauth/c2pa-rs',
132+
path: 'README.md',
133+
},
134+
{
135+
dest: resolve(__dirname, '../docs/rust-sdk/docs/supported-formats.md'),
136+
repo: 'contentauth/c2pa-rs',
137+
path: 'docs/supported-formats.md',
138+
},
139+
{
140+
dest: resolve(__dirname, '../docs/rust-sdk/docs/usage.md'),
141+
repo: 'contentauth/c2pa-rs',
142+
path: 'docs/usage.md',
143+
},
144+
{
145+
dest: resolve(__dirname, '../docs/rust-sdk/docs/release-notes.md'),
146+
repo: 'contentauth/c2pa-rs',
147+
path: 'docs/release-notes.md',
148+
},
149+
{
150+
dest: resolve(__dirname, '../docs/c2pa-min/readme.md'),
151+
repo: 'contentauth/c2pa-min',
152+
path: 'README.md',
153+
},
82154
];
83155

84156
function resolveMarkdownLinks(linkBase, content) {
@@ -101,8 +173,9 @@ async function download() {
101173
const linkBase = `${GITHUB_HOST}/${repo}/blob/${branch}/${path}`;
102174
const res = await fetch(src);
103175
const markdown = await res.text();
104-
const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
105-
await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
176+
//const resolvedMarkdown = resolveMarkdownLinks(linkBase, markdown);
177+
//await writeFile(dest, resolvedMarkdown, { encoding: 'utf-8', flag: 'w+' });
178+
await writeFile(dest, markdown, { encoding: 'utf-8', flag: 'w+' });
106179
console.log('Saved %s to %s', src, dest);
107180
}
108181
}

‎scripts/generate-api-docs/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ function appendStringToFiles(directory, stringToAppend) {
7272
return;
7373
}
7474

75-
console.log(`Appended "${stringToAppend}" to ${file}`);
75+
//console.log(`Appended "${stringToAppend}" to ${file}`);
7676
});
7777
});
7878
});

‎sidebars.js‎

Lines changed: 89 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,37 @@ const sidebars = {
6767
link: { type: 'doc', id: 'c2patool/readme' },
6868
collapsed: true,
6969
items: [
70+
/* Waiting for https://github.com/contentauth/c2patool/pull/296
7071
{
7172
type: 'doc',
72-
id: 'c2patool/manifest',
73+
id: 'c2patool/docs/usage',
74+
label: 'Using C2PA Tool',
75+
},
76+
{
77+
type: 'doc',
78+
id: 'c2patool/docs/supported-formats',
79+
label: 'Supported media formats',
80+
},
81+
*/
82+
{
83+
type: 'doc',
84+
id: 'c2patool/docs/manifest',
7385
label: 'Using a manifest file',
7486
},
7587
{
7688
type: 'doc',
77-
id: 'c2patool/x_509',
78-
label: 'Creating and using a certificate',
89+
id: 'c2patool/docs/x_509',
90+
label: 'Using a certificate',
91+
},
92+
{
93+
type: 'doc',
94+
id: 'c2patool/docs/release-notes',
95+
label: 'Release notes',
7996
},
8097
{
8198
type: 'doc',
8299
id: 'c2pa-service-example/readme',
100+
label: 'C2PA Tool service example',
83101
},
84102
{
85103
type: 'link',
@@ -109,14 +127,30 @@ const sidebars = {
109127
collapsed: true,
110128
items: [
111129
{
112-
type: 'link',
113-
label: 'GitHub',
114-
href: 'https://github.com/contentauth/c2pa-node',
130+
type: 'doc',
131+
id: 'c2pa-node/docs/usage',
132+
label: 'Using the Node library',
133+
},
134+
{
135+
type: 'doc',
136+
id: 'c2pa-node/docs/supported-formats',
137+
label: 'Supported media formats',
115138
},
116139
{
117140
type: 'doc',
141+
id: 'c2pa-node/docs/release-notes',
142+
label: 'Release notes',
143+
},
144+
{
145+
type: 'doc',
146+
label: 'C2PA Node example',
118147
id: 'c2pa-node-example/readme',
119148
},
149+
{
150+
type: 'link',
151+
label: 'GitHub',
152+
href: 'https://github.com/contentauth/c2pa-node',
153+
},
120154
],
121155
},
122156
{
@@ -126,14 +160,29 @@ const sidebars = {
126160
collapsed: true,
127161
items: [
128162
{
129-
type: 'link',
130-
label: 'GitHub',
131-
href: 'https://github.com/contentauth/c2pa-python',
163+
type: 'doc',
164+
id: 'c2pa-python/docs/usage',
165+
label: 'Using the Python library',
166+
},
167+
{
168+
type: 'doc',
169+
id: 'c2pa-python/docs/supported-formats',
170+
label: 'Supported media formats',
171+
},
172+
{
173+
type: 'doc',
174+
id: 'c2pa-python/docs/release-notes',
175+
label: 'Release notes',
132176
},
133177
{
134178
type: 'doc',
135-
label: 'C2PA Python Example',
136179
id: 'c2pa-python-example/readme',
180+
label: 'C2PA Python example',
181+
},
182+
{
183+
type: 'link',
184+
label: 'GitHub',
185+
href: 'https://github.com/contentauth/c2pa-python',
137186
},
138187
],
139188
},
@@ -143,6 +192,16 @@ const sidebars = {
143192
link: { type: 'doc', id: 'c2pa-c/readme' },
144193
collapsed: true,
145194
items: [
195+
{
196+
type: 'doc',
197+
id: 'c2pa-c/docs/usage',
198+
label: 'Using the C++ library',
199+
},
200+
{
201+
type: 'doc',
202+
id: 'c2pa-c/docs/supported-formats',
203+
label: 'Supported media formats',
204+
},
146205
{
147206
type: 'link',
148207
label: 'GitHub',
@@ -159,21 +218,36 @@ const sidebars = {
159218
link: { type: 'doc', id: 'rust-sdk/readme' },
160219
collapsed: true,
161220
items: [
221+
{
222+
type: 'doc',
223+
id: 'rust-sdk/docs/usage',
224+
label: 'Using the Rust library',
225+
},
226+
{
227+
type: 'doc',
228+
id: 'rust-sdk/docs/supported-formats',
229+
label: 'Supported media formats',
230+
},
231+
{
232+
type: 'doc',
233+
id: 'rust-sdk/docs/release-notes',
234+
label: 'Release notes',
235+
},
162236
{
163237
type: 'link',
164238
label: 'API documentation',
165239
href: 'https://docs.rs/c2pa',
166240
},
241+
{
242+
type: 'doc',
243+
id: 'c2pa-min/readme',
244+
label: 'C2PA Rust example application',
245+
},
167246
{
168247
type: 'link',
169248
label: 'GitHub',
170249
href: 'https://github.com/contentauth/c2pa-rs',
171250
},
172-
{
173-
type: 'doc',
174-
label: 'C2PA Rust example application',
175-
id: 'c2pa-min/readme',
176-
},
177251
],
178252
},
179253
{

0 commit comments

Comments
 (0)