Skip to content

Commit 9b4908d

Browse files
authored
Merge pull request #232 from contentauth/mobile-libraries
Add mobile libraries to docs
2 parents 999a867 + 5f76e8f commit 9b4908d

File tree

6 files changed

+43
-12
lines changed

6 files changed

+43
-12
lines changed

docs/c2pa-android/.gitkeep

Whitespace-only changes.

docs/c2pa-ios/.gitkeep

Whitespace-only changes.

docs/community.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,6 @@ We also welcome thoughtful pull requests (PRs) from the community, following the
2929

3030
Participants are required to follow the [Adobe Code of Conduct](https://github.com/contentauth/c2pa-rs/blob/main/CODE_OF_CONDUCT.md) to maintain an open and welcoming environment for all.
3131

32-
### Incubator projects
33-
34-
:::warning Warning
35-
Incubator projects are still under active development and are not yet ready for general use. However, input and bug reports are welcome in the GitHub repositories.
36-
:::
37-
38-
These projects are in early alpha release:
39-
- [iOS Library](https://github.com/contentauth/c2pa-ios): Provides iOS/macOS support via Swift Package/XCFramework.
40-
- [Android Library](https://github.com/contentauth/c2pa-android): Provides native Android support via an AAR library.
41-
42-
Both of these projects wrap the C2PA Rust implementation ([c2pa-rs](https://github.com/contentauth/c2pa-rs)) using its C API bindings.
43-
4432
### Related projects
4533

4634
These related projects may be of interest, but the CAI team doesn't maintain or support them:

docs/mobile.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: mobile
3+
title: Mobile libraries
4+
---
5+
6+
:::warning Warning
7+
These projects have recently graduated from "incubator" status, but are still under active development. They may have bugs and missing features: Bug reports and feature requests are welcome in the GitHub repositories.
8+
:::
9+
10+
These projects are available to enable developing apps for mobile devices:
11+
- [**iOS Library**](/c2pa-ios/README.md): Provides iOS/macOS support via Swift Package/XCFramework. <br/>GitHub repository: <https://github.com/contentauth/c2pa-ios>.
12+
- [**Android Library**](c2pa-android/README.md): Provides native Android support via an AAR library. <br/>GitHub repository: <https://github.com/contentauth/c2pa-android>.
13+
14+
Both of these projects wrap the C2PA Rust implementation ([c2pa-rs](https://github.com/contentauth/c2pa-rs)) using its C API bindings.

scripts/fetch-readme.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,17 @@ const readmes = [
244244
repo: 'adobe/trustmark',
245245
path: 'rust/crates/trustmark-cli/README.md',
246246
},
247+
// Mobile libraries
248+
{
249+
dest: resolve(__dirname, '../docs/c2pa-ios/README.md'),
250+
repo: 'contentauth/c2pa-ios',
251+
path: 'README.md',
252+
},
253+
{
254+
dest: resolve(__dirname, '../docs/c2pa-android/README.md'),
255+
repo: 'contentauth/c2pa-android',
256+
path: 'README.md',
257+
},
247258
];
248259

249260
function resolveMarkdownLinks(linkBase, content) {

sidebars.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,24 @@ const sidebars = {
256256
},
257257
],
258258
},
259+
{
260+
type: 'category',
261+
label: 'Mobile libraries',
262+
link: { type: 'doc', id: 'mobile' },
263+
collapsed: true,
264+
items: [
265+
{
266+
type: 'doc',
267+
id: 'c2pa-ios/README',
268+
label: 'iOS',
269+
},
270+
{
271+
type: 'doc',
272+
id: 'c2pa-android/README',
273+
label: 'Android',
274+
},
275+
],
276+
},
259277
{
260278
type: 'category',
261279
label: 'Rust library',

0 commit comments

Comments
 (0)