Refactor scripts #184
Refactor scripts #184
Conversation
| label: 'Packages', | ||
| items: [terminalNode('Overview', 'index')], | ||
| collapsed: false, | ||
| }), |
There was a problem hiding this comment.
Can you elaborate on what's happening here? I wanna make sure I understand
Also, is there a PR in the JS SDK side to move things that we can't make open source?
There was a problem hiding this comment.
This code generates the sidebar navigation for the API docs, e.g. for Packages https://opensource.contentauthenticity.org/docs/js-sdk/api/. Currently, there's only one package, c2pa.
The following is from GH co-pilot ;-)
Each key in the SIDEBAR_VISITOR object corresponds to a specific kind of API item, such as Package, Namespace, Interface, Class, and various others. The associated function for each key takes two parameters: apiItem, which represents the API item being processed, and meta, which contains metadata about the item. Depending on the kind of API item, the function either calls containerNode or terminalNode to generate the sidebar node.
Also, is there a PR in the JS SDK side to move things that we can't make open source?
The JS SDK is already open source: https://github.com/contentauth/c2pa-js
This PR doesn't do anything re that; it's only for the the code in this repo, which creates the docs.
There was a problem hiding this comment.
so just reformatting right?
and apiItem and meta are passed into the larger function?
|
Unfortunately the build is failing, and we can't merge this until we figure out why: https://github.com/contentauth/opensource.contentauth.org/actions/runs/12836425144/job/35797981248 |
|
Rather than try to figure this out, I opened a PR to add a license to the source repo: LICENSE. So, now we should be able to make this repo public without any problem. |
Changes in this pull request
Refactor scripts used for sidebar and JS API docs.
Fixes #167 .