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.

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

docs: update Presence throttling notes #23377

Merged

Conversation

jason-ha
Copy link
Contributor

to match presence package readme.

Throttling implementation was added in v2.11.0.

to match presence package readme.

Throttling implementation was added in v2.11.0.
@jason-ha jason-ha requested review from Copilot, Josmithr, kashms, pk-pranshu, tylerbutler and WillieHabi and removed request for Copilot December 19, 2024 19:30
@github-actions github-actions bot added area: website base: main PRs targeted against main branch labels Dec 19, 2024

You can configure the grouping and throttling behavior using the `allowableUpdateLatencyMs` property as in the following example:

```ts
Copy link
Contributor

@Josmithr Josmithr Dec 19, 2024

Choose a reason for hiding this comment

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

Not for this PR, but this reminded me: I'm trying to establish a pattern for maintaining "living" code examples for use in docs contexts like this. I'd be interested in your thoughts on it.

PR: #23324

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like living examples. To be most effective they would have to be tied to the released code. But most docs are slightly divorced from what is released. That means updating after or with release and we'll mess it up. I support figuring it all out for sure.

Copy link
Contributor

Choose a reason for hiding this comment

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

But most docs are slightly divorced from what is released.

True in a lot of cases, but for package-local documentation like this, the two should generally be in-sync.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Main docs are from main branch and API docs are from latest released branch. That 2-to-3-week possible disparity is what you mean by "generally in-sync"?

Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170142 links
    1596 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors


@jason-ha jason-ha merged commit 4a66474 into microsoft:main Dec 20, 2024
37 checks passed
@jason-ha jason-ha deleted the presence/update-docs-for-throttling-support branch December 20, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: website base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants