Skip to content

docs(client-presence): additions/updates to exposed APIs #24875

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

Merged
merged 1 commit into from
Jun 19, 2025

Conversation

jason-ha
Copy link
Contributor

@jason-ha jason-ha commented Jun 18, 2025

@system types given top-level descriptions without member details.

@Copilot Copilot AI review requested due to automatic review settings June 18, 2025 22:07
@jason-ha jason-ha requested a review from a team as a code owner June 18, 2025 22:07
@github-actions github-actions bot added area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct public api change Changes to a public API base: main PRs targeted against main branch labels Jun 18, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves and clarifies the documentation for the client-presence APIs by updating inline comments and API report annotations.

  • Updated documentation comments in packages/framework/presence/src/presence.ts to clearly describe the roles of attendees, states, and notifications.
  • Added documentation for internal types in packages/framework/presence/src/exposedInternalTypes.ts.
  • Revised the API report markdown files to remove the "(undocumented)" markers and standardize the @System annotations.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
packages/framework/presence/src/presence.ts Updated interface comments to better explain API components and introduce notifications.
packages/framework/presence/src/exposedInternalTypes.ts Added doc comments describing metadata and internal types.
packages/framework/presence/api-report/presence.beta.api.md Removed undocumented markers for a consistent @System annotation.
packages/framework/presence/api-report/presence.alpha.api.md Removed undocumented markers for a consistent @System annotation.
Comments suppressed due to low confidence (1)

packages/framework/presence/src/presence.ts:167

  • The updated documentation now provides separate descriptions for Presence features with and without notifications. Consider adding a brief note to clarify the distinction between the two descriptions if they represent different API variants.
 *

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:
  225443 links
    1710 destination URLs
    1941 URLs ignored
       0 warnings
       0 errors


@jason-ha jason-ha enabled auto-merge (squash) June 19, 2025 16:38
Copy link
Contributor

@noencke noencke left a comment

Choose a reason for hiding this comment

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

API approval

@jason-ha jason-ha merged commit 82a93d8 into microsoft:main Jun 19, 2025
38 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants