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.

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

doc: Reorganization #689

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

doc: Reorganization #689

wants to merge 13 commits into from

Conversation

crandmck
Copy link
Collaborator

@crandmck crandmck commented Nov 18, 2024

Changes in this pull request

Create new docs directory and move some content from README to new files there:

  • release-notes.md - Release notes, including info on new API that's currently in 2024_API_NOTES.md
  • usage.md - Docs on using the library. Currently minimal, will expand in future.
  • supported-formats.md - Table of supported media file formats. Having this in a separate file makes it easier to "transclude" it into docs for other libraries (noting any diffs).
  • project-contributions.md - Info for anyone who wants to contribute to (vs. use) the crate, including testing info.

For details, see https://wiki.corp.adobe.com/display/CAI/Rust+library+docs.

Checklist

  • This PR represents a single feature, fix, or change.
  • All applicable changes have been documented.
  • Any TO DO items (or similar) have been entered as GitHub issues and the link to that issue has been included in a comment.

@crandmck crandmck marked this pull request as draft November 18, 2024 22:47
Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.51%. Comparing base (2a41ee5) to head (0dc9301).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #689      +/-   ##
==========================================
- Coverage   81.52%   81.51%   -0.01%     
==========================================
  Files         104      104              
  Lines       30614    30614              
==========================================
- Hits        24958    24956       -2     
- Misses       5656     5658       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@crandmck crandmck marked this pull request as ready for review November 20, 2024 21:33
Copy link
Collaborator

@gpeacock gpeacock left a comment

Choose a reason for hiding this comment

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

A few comments added

* `chore`
* `ci`
* `docs`
* `feat`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we allowing all these? I thought there were only chore, docs, feat and fix.


### Enabling

<!-- This requirement should go away with actual 1.0 release, right? -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, it will go away soon!

| | set_claim_generator_info | | | | |
| | set_format | | | | |
| | set_remote_url | | X | | |
| | set_no_embed | | X | | |
Copy link
Collaborator

Choose a reason for hiding this comment

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

C++ now supports set_remote_url, set_no_embed, data_hashed_placeholder and sign_data_hashed_embeddable.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Actually need to update a bunch of things on this chart, so just submit as is and I'll follow up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants