Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add client requirements template to default README contents #21815

Merged
merged 19 commits into from
Jul 11, 2024
Merged

docs: Add client requirements template to default README contents #21815

merged 19 commits into from
Jul 11, 2024

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Jul 10, 2024 •
edited by azure-boards bot
Loading

Also updates Client Requirements.md to just use the template directly. Effectively moves the source of truth for that document into markdown-magic.

AB#8577
@Josmithr
feat: Support heading level override and add "ClientRequirements" tra…
c9db5ba 
…nsform
@Josmithr
fix: heading level handling + cleanup
3bb5b91
@Josmithr
docs: Update ClientRequirements.md to use template
9ec0d80
@Josmithr
revert: Client Requirements template changes
0c70f7f
@Josmithr
docs: Fix typo
304505d
@Josmithr
docs: Update transform comment examples
587e454
@Josmithr
docs: Update includeHeading docs in package README
e5bfa42
@Josmithr
docs: Add headingLevel notes to README
bf51192
@Josmithr
Merge branch 'main' into markdown-magic/allow-heading-level-override
53c22b8
@Josmithr
[WIP]
1b8636d
@Josmithr
Revert "revert: Client Requirements template changes"
fc2b732 
This reverts commit 0c70f7f.
@Josmithr
fix: Reconnect template offset handling
f6d16df
@Josmithr
style: Formatting
0870621
@Josmithr
test: Update test collateral
df1ac57
@Josmithr
docs: Update READMEs
964555c
@Josmithr
docs: Update package README
1b56c7f
@Josmithr
Merge branch 'main' into markdown-magic/minimum-requirements-template
39b674e
@Josmithr Josmithr requested a review from a team July 10, 2024 00:31
@github-actions github-actions bot added the base: main PRs targeted against main branch label Jul 10, 2024
@github-actions github-actions bot added area: build Build related issues area: dds Issues related to distributed data structures area: dds: sharedstring area: dds: tree area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver labels Jul 10, 2024
@github-actions github-actions bot added area: runtime Runtime related issues area: tests Tests to add, test infrastructure improvements, etc labels Jul 10, 2024
@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Jul 10, 2024 •
edited
Loading

⯅ @fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 456.49 KB 456.53 KB ⯅ +35 Bytes
azureClient.js 554.23 KB 554.28 KB ⯅ +49 Bytes
connectionState.js 680 Bytes 680 Bytes ■ No change
containerRuntime.js 257.7 KB 257.72 KB ⯅ +14 Bytes
fluidFramework.js 391.41 KB 391.43 KB ⯅ +14 Bytes
loader.js 134.1 KB 134.11 KB ⯅ +14 Bytes
map.js 42.17 KB 42.17 KB ⯅ +7 Bytes
matrix.js 145.43 KB 145.44 KB ⯅ +7 Bytes
odspClient.js 522.23 KB 522.28 KB ⯅ +49 Bytes
odspDriver.js 97.17 KB 97.19 KB ⯅ +21 Bytes
odspPrefetchSnapshot.js 42.27 KB 42.29 KB ⯅ +14 Bytes
sharedString.js 162.51 KB 162.52 KB ⯅ +7 Bytes
sharedTree.js 381.87 KB 381.88 KB ⯅ +7 Bytes
Total Size 3.26 MB 3.26 MB ⯅ +245 Bytes

Baseline commit: 2cb1e35

Generated by 🚫 dangerJS against beb5906

Josmithr
Josmithr commented Jul 10, 2024
View reviewed changes
ClientRequirements.md
@@ -1,5 +1,10 @@
# Platform Requirements for Fluid Framework Client Packages
Copy link
Contributor Author

@Josmithr Josmithr Jul 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: this document used to be the "source of truth" of this information. This PR would move that source of truth into the markdown-magic templates directory (here), but we still want to retain this information at the root of the repo for discoverability.
Josmithr
Josmithr commented Jul 10, 2024
View reviewed changes
tools/markdown-magic/src/templates/Client-Requirements-Template.md
@@ -0,0 +1,41 @@
These are the platform requirements for the current version of Fluid Framework Client Packages.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: this becomes the new "source of truth" for the client requirements documentation.
kashms
kashms approved these changes Jul 11, 2024
View reviewed changes
Copy link
Contributor

@kashms kashms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
CraigMacomber
CraigMacomber approved these changes Jul 11, 2024
View reviewed changes
Copy link
Contributor

@CraigMacomber CraigMacomber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Output. Seems good to me. I didn't review the code changes much.
@Josmithr Josmithr merged commit bb3e0dd into microsoft:main Jul 11, 2024
36 checks passed
@Josmithr Josmithr deleted the markdown-magic/minimum-requirements-template branch July 11, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: build Build related issues area: dds: sharedstring area: dds: tree area: dds Issues related to distributed data structures area: dev experience Improving the experience of devs building on top of fluid area: driver Driver related issues area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: odsp-driver area: runtime Runtime related issues area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch
4 participants
@Josmithr @msfluid-bot @CraigMacomber @kashms