Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README edit and cleanup #40

Closed
wants to merge 11 commits into from
Closed

README edit and cleanup #40

wants to merge 11 commits into from

Conversation

crandmck
Copy link
Contributor

@crandmck crandmck commented Nov 13, 2023 •
edited
Loading

Some small edits, added TOC (which won't be displayed on doc site), made /docs/README.md be the API doc index instead of a dup. of the README.

Also changed package.json to put API doc index in docs/README.md instead of docs/modules.md.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 13, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 67ad05a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@crandmck crandmck requested a review from dkozma November 14, 2023 18:59
dkozma
dkozma requested changes Nov 16, 2023
View reviewed changes
docs/classes/ManifestBuilder.md
| `options?` | `ManifestBuilderOptions` |

#### Defined in

[lib/manifestBuilder.ts:41](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L41)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might need to not do this through a fork, since it seems to be changing the URLs to your fork. Can you push this PR to the main repo, rebuild, and open up a PR from there?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Moved to a branch and created new PR.

@crandmck crandmck mentioned this pull request Nov 16, 2023
Merged
@crandmck
Copy link
Contributor Author

Close in favor of #41

@crandmck crandmck closed this Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dkozma dkozma dkozma requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@crandmck @dkozma