docs(merge-tree,sequence): Update READMEs with common template contents (#21751)

Also updates embed line numbers for website articles, which copy
contents from these READMEs for public consumption.
This commit is contained in:
Joshua Smithrud 2024-07-03 08:20:06 -07:00 коммит произвёл GitHub
Родитель 755ce9fba6
Коммит 8760ce16dc
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
5 изменённых файлов: 137 добавлений и 3 удалений

Просмотреть файл

@ -7,7 +7,7 @@ menuPosition: 5
argument) and then run "npm run build:md-magic" from the docs folder. That will update all autogenerated
content, so you should commit the resulting changes. -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/counter/README.md&start=38&end=174)) -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/counter/README.md&start=38&end=174) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated by embedding the referenced file contents. Do not update these generated contents directly. -->

Просмотреть файл

@ -9,7 +9,7 @@ aliases:
argument) and then run "npm run build:md-magic" from the docs folder. That will update all autogenerated
content, so you should commit the resulting changes. -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/sequence/README.md&start=20&end=512) -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/sequence/README.md&start=40&end=532) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated by embedding the referenced file contents. Do not update these generated contents directly. -->

Просмотреть файл

@ -59,7 +59,7 @@ efficient spatial querying of the nearest Marker to a given position. -->
argument) and then run "npm run build:md-magic" from the docs folder. That will update all autogenerated
content, so you should commit the resulting changes. -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/sequence/README.md&start=592&end=609) -->
<!-- AUTO-GENERATED-CONTENT:START (INCLUDE:path=../../../../packages/dds/sequence/README.md&start=612&end=628) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated by embedding the referenced file contents. Do not update these generated contents directly. -->

Просмотреть файл

@ -22,6 +22,24 @@ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs),
<!-- AUTO-GENERATED-CONTENT:END -->
<!-- AUTO-GENERATED-CONTENT:START (README_IMPORT_INSTRUCTIONS:includeHeading=TRUE) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
## Importing from this package
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/merge-tree` like normal.
To access the `legacy` APIs, import via `@fluidframework/merge-tree/legacy`.
<!-- prettier-ignore-end -->
<!-- AUTO-GENERATED-CONTENT:END -->
## Operations
The three basic operations provided by MergeTree are:
@ -114,3 +132,50 @@ consequently should be ignored during the search.
Note that any locally applied operations that are still pending sequencing by the Fluid service are unknown to
remote clients and should be ignored when processing remote ops.
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&installation=FALSE&importInstructions=FALSE) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
## API Documentation
API documentation for **@fluidframework/merge-tree** is available at <https://fluidframework.com/docs/apis/merge-tree>.
## Contribution Guidelines
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsofts [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
## Help
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
Thank you!
## Trademark
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
<!-- prettier-ignore-end -->
<!-- AUTO-GENERATED-CONTENT:END -->

Просмотреть файл

@ -17,6 +17,26 @@ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs),
<!-- AUTO-GENERATED-CONTENT:END -->
<!-- AUTO-GENERATED-CONTENT:START (README_IMPORT_INSTRUCTIONS:includeHeading=TRUE) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
## Importing from this package
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/sequence` like normal.
To access the `beta` APIs, import via `@fluidframework/sequence/beta`.
To access the `legacy` APIs, import via `@fluidframework/sequence/legacy`.
<!-- prettier-ignore-end -->
<!-- AUTO-GENERATED-CONTENT:END -->
## Description
The **@fluidframework/sequence** package supports distributed data structures which are list-like.
@ -609,5 +629,54 @@ For further reading on attribution, see the [@fluid-experimental/attributor READ
<!-- This line ends the content that is copied to the string.md README -->
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&installation=FALSE&importInstructions=FALSE) -->
<!-- prettier-ignore-start -->
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
## API Documentation
API documentation for **@fluidframework/sequence** is available at <https://fluidframework.com/docs/apis/sequence>.
## Contribution Guidelines
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsofts [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
## Help
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
Thank you!
## Trademark
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
<!-- prettier-ignore-end -->
<!-- AUTO-GENERATED-CONTENT:END -->
<!-- Links -->
[sharedmap]: https://fluidframework.com/docs/data-structures/map/
[sharedstring]: https://github.com/microsoft/FluidFramework/blob/main/packages/dds/sequence/src/sharedString.ts