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

improvement(markdown-magic): Only generate API docs sections for "public" packages #21902

Merged
merged 6 commits into from
Jul 16, 2024
Merged

improvement(markdown-magic): Only generate API docs sections for "public" packages #21902

merged 6 commits into from
Jul 16, 2024

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Jul 16, 2024 •
edited
Loading

Ensures we don't generate API docs sections for packages that are not published / whose docs are not published.

Also removes now-unneeded param overrides in private/internal package READMEs.

@Josmithr Josmithr requested review from alexvy86 and a team July 16, 2024 18:26
@github-actions github-actions bot added area: build Build related issues area: loader Loader related issues area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch labels Jul 16, 2024
@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Jul 16, 2024 •
edited
Loading

⯅ @fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 457.54 KB 457.58 KB ⯅ +35 Bytes
azureClient.js 555.24 KB 555.29 KB ⯅ +49 Bytes
connectionState.js 680 Bytes 680 Bytes ■ No change
containerRuntime.js 258.68 KB 258.7 KB ⯅ +14 Bytes
fluidFramework.js 391.52 KB 391.53 KB ⯅ +14 Bytes
loader.js 134.02 KB 134.03 KB ⯅ +14 Bytes
map.js 42.12 KB 42.12 KB ⯅ +7 Bytes
matrix.js 145.63 KB 145.63 KB ⯅ +7 Bytes
odspClient.js 523.06 KB 523.11 KB ⯅ +49 Bytes
odspDriver.js 97.22 KB 97.24 KB ⯅ +21 Bytes
odspPrefetchSnapshot.js 42.27 KB 42.29 KB ⯅ +14 Bytes
sharedString.js 162.64 KB 162.65 KB ⯅ +7 Bytes
sharedTree.js 382.03 KB 382.04 KB ⯅ +7 Bytes
Total Size 3.27 MB 3.27 MB ⯅ +245 Bytes

Baseline commit: 72850b8

Generated by 🚫 dangerJS against a7bf8a8

alexvy86
alexvy86 approved these changes Jul 16, 2024
View reviewed changes
tools/markdown-magic/src/md-magic.config.cjs Outdated Show resolved Hide resolved
@Josmithr @alexvy86
docs: Update param docs phrasing
a7bf8a8 
Co-authored-by: Alex Villarreal <716334+alexvy86@users.noreply.github.com>
@Josmithr Josmithr enabled auto-merge (squash) July 16, 2024 19:59
@Josmithr Josmithr merged commit bd32470 into microsoft:main Jul 16, 2024
40 checks passed
@Josmithr Josmithr deleted the markdown-magic/api-docs-scope-filtering branch July 16, 2024 20:51
RishhiB pushed a commit to RishhiB/FluidFramework-1 that referenced this pull request Jul 18, 2024
@Josmithr @RishhiB
improvement(markdown-magic): Only generate API docs sections for "pub…
821c793 
…lic" packages (microsoft#21902)

Ensures we don't generate API docs sections for packages that are not
published / whose docs are not published.

Also removes now-unneeded param overrides in private/internal package
READMEs.
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexvy86 alexvy86 alexvy86 approved these changes

Assignees
No one assigned
Labels
area: build Build related issues area: loader Loader related issues area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Josmithr @msfluid-bot @alexvy86