-
Notifications
You must be signed in to change notification settings - Fork 37
(IGNORE) Split README into several files in new docs dir #136
Conversation
Codecov Report
❗ 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 |
@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. |
There was a problem hiding this 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!
Thanks, I revised the wording accordingly! Please merge. |
…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>
Changes in this pull request
This PR is paired with contentauth/opensource.contentauth.org#77, which should be merged AFTER this one.
docs
directory.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#76x_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.