microsoft / FluidFramework

Library for building distributed, real-time collaborative web applications
https://fluidframework.com
MIT License
4.7k stars 528 forks source link

docs: Update markdown-magic to only generate "Client Requirements" section of README header for "public" packages #21930

Closed Josmithr closed 1 month ago

Josmithr commented 1 month ago

The "Client Requirements" section is specifically intended to provide end-users with usage contract information. Non-public packages don't need this information. Additionally, such information is (generally) not applicable to "tools" packages, many of which are intended to run in Node, rather than a browser.

msfluid-bot commented 1 month ago
@fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 457.6 KB 457.63 KB +35 Bytes
azureClient.js 555.37 KB 555.42 KB +49 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 258.68 KB 258.7 KB +14 Bytes
fluidFramework.js 391.58 KB 391.59 KB +14 Bytes
loader.js 134.08 KB 134.09 KB +14 Bytes
map.js 42.17 KB 42.18 KB +7 Bytes
matrix.js 145.68 KB 145.69 KB +7 Bytes
odspClient.js 523.52 KB 523.57 KB +49 Bytes
odspDriver.js 97.55 KB 97.57 KB +21 Bytes
odspPrefetchSnapshot.js 42.61 KB 42.62 KB +14 Bytes
sharedString.js 162.69 KB 162.7 KB +7 Bytes
sharedTree.js 382.09 KB 382.1 KB +7 Bytes
Total Size 3.27 MB 3.27 MB +245 Bytes

Baseline commit: 6a6353f02ff385254eec5a5b4c943a367dd16a6e

Generated by :no_entry_sign: dangerJS against ccf42676d4de421d0ac56adb0a51bfe2540dba9d