Skip to content
This repository has been archived by the owner on Dec 11, 2024. It is now read-only.

(IGNORE) Split README into several files in new docs dir #136

Merged
merged 8 commits into from
Aug 23, 2023
Merged

Conversation

crandmck
Copy link
Collaborator

@crandmck crandmck commented Aug 15, 2023

Changes in this pull request

This PR is paired with contentauth/opensource.contentauth.org#77, which should be merged AFTER this one.

  • Adds a new docs directory.
  • Breaks up the README.md into 3 additional files in this directory that contain distinct content:
    • manifest.md contains brief overview info on manifests and an example. This will eventually be replaced with other content on the docs site per Add docs for manifest JSON opensource.contentauth.org#76
    • x_509.md contains the info on "creating and using an X.509 certificate".
    • release-notes.md contains high-level release notes info.

To see how the docs will look when this PR is merged, see https://deploy-preview-77--cai-open-source.netlify.app/docs/c2patool/ which is the deploy preview for contentauth/opensource.contentauth.org#77.

@crandmck crandmck changed the title [WIP - DO NOT MERGE] Split README into several files in new docs dir (IGNORE) [WIP - DO NOT MERGE] Split README into several files in new docs dir Aug 15, 2023
@crandmck crandmck added the documentation Improvements or additions to documentation label Aug 15, 2023
@codecov-commenter
Copy link

codecov-commenter commented Aug 15, 2023

Codecov Report

Merging #136 (80aa959) into main (5328d5a) will decrease coverage by 0.27%.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##             main     #136      +/-   ##
==========================================
- Coverage   84.18%   83.91%   -0.27%     
==========================================
  Files           3        3              
  Lines         373      373              
==========================================
- Hits          314      313       -1     
- Misses         59       60       +1     

see 1 file with indirect coverage changes

@crandmck crandmck requested a review from gpeacock August 16, 2023 20:52
@crandmck crandmck changed the title (IGNORE) [WIP - DO NOT MERGE] Split README into several files in new docs dir (IGNORE) Split README into several files in new docs dir Aug 16, 2023
@crandmck
Copy link
Collaborator Author

@gpeacock I believe this is ready to be merged. Once we do that, then we can merge contentauth/opensource.contentauth.org#77 so that all the content is pulled into the doc site properly.

docs/release-notes.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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.

One nit about Release Notes no longer being a section, otherwise looks good!

@crandmck
Copy link
Collaborator Author

crandmck commented Aug 22, 2023

Thanks, I revised the wording accordingly! Please merge.

@gpeacock gpeacock merged commit 53ebc56 into main Aug 23, 2023
@gpeacock gpeacock deleted the chunk-docs branch August 23, 2023 16:24
scouten-adobe pushed a commit to contentauth/c2pa-rs that referenced this pull request Dec 10, 2024
…2patool#136)

* Split README into several files, cread docs dir

* Change link to spec 1.3, make doc links absolute

* minor wording edits

* Add Docusaurus styling so xrefs to other md pages in repo is not displayed on site

* Make link relative not absolute

* Update release-notes.md

* Fix link in CONTRIBUTING.md to CODE_OF_CONDUCT.md, add README TOC

* Move TOC to better location in README

---------

Co-authored-by: Rand McKinney <rmckinne@adobe.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants