docs: Update package READMEs to leverage markdown-magic header and footer templates
#22013
Conversation
github-actions
bot
added
base: main
| @@ -1,5 +1,14 @@ | |||
| # @fluid-example/table-document | |||
|
|
|||
| <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) --> | |||
There was a problem hiding this comment.
TODO: this is a case that was not previously considered. We do a have a few example libraries in addition to example apps. We will want to update the library README header template to include a notice for example libraries. Ideally, these shouldn't be published. But this package, in particular, is (see the note starting on line 30 for context). Anyone who sees this package on npm or in our github should be confronted with a notice about the nature of this libarary.
Will address in a follow-up PR. Leaving the template here for now so it will auto-update with that PR.
| @@ -28,7 +57,6 @@ The order of the edits is: | |||
| 1. All acknowledged edits, in the order agreed upon by Fluid's consensus. | |||
| 2. All local edits (not acknowledged by Fluid yet), in the order they were applied. | |||
|
|
|||
| **Important: this DDS is no longer in active development, and a non-experimental, officially supported SharedTree is in active development by the Fluid team that will expand on its rich feature set.** | |||
There was a problem hiding this comment.
Note for reviewers: Moved this to the top of the README and updated it to point to the new tree library.
| **Topics covered below:** | ||
|
|
||
| - [@fluidframework/container-loader](#fluidframeworkcontainer-loader) | ||
| - [Using Fluid Framework libraries](#using-fluid-framework-libraries) | ||
| - [Installation](#installation) | ||
| - [Importing from this package](#importing-from-this-package) | ||
| - [API Documentation](#api-documentation) |
There was a problem hiding this comment.
These contents were out of date.
| @@ -1 +1,46 @@ | |||
| # @fluid-internal/functional-tests | |||
|
|
|||
| TODO: Document this package | |||
There was a problem hiding this comment.
Not for this PR, but we shouldn't have packages (even private ones) without basic documentation explaining what they are.
| @@ -4,18 +4,6 @@ _Note: This tool has dependencies on Microsoft-internal systems._ | |||
|
|
|||
| NodeJs-based test to simulate many clients and a high rate of op generation. | |||
|
|
|||
| <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) --> | |||
There was a problem hiding this comment.
Note for reviewers: this package isn't a library, it just contains tests. So the library header really isn't appropriate.
⯅ @fluid-example/bundle-size-tests: +245 Bytes
Baseline commit: 90ddf1c |
| @@ -26,7 +26,7 @@ function initializeTinyliciousClient(): TinyliciousClient { | |||
| } | |||
| ``` | |||
|
|
|||
| <!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=FALSE) --> | |||
| <!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=FALSE) --> | |||
|
|
|||
There was a problem hiding this comment.
Do the contribution guidelines need to be added here too?
There was a problem hiding this comment.
They're already included toward the bottom of the file
There was a problem hiding this comment.
A handful of these already contained the footer pragma, but were using only a subset of the header contents.
Also makes a few misc. cleanup changes