Skip to content

Conversation

@alison-mk
Copy link
Contributor

@alison-mk alison-mk commented Aug 27, 2025

This PR creates a preview APIs article, modeled after the Excel JavaScript Preview APIs article. The table in this PR is currently static, although it could be automated in the future once the format has been finalized.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 4032d1e:

💡 Validation status: suggestions

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md 💡Suggestion View (office-scripts) Details
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

docs/docs-ref-autogen/preview-apis.md

  • Line 19, Column 3: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 19, Column 35: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript/officescript.emailattachment' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 20, Column 3: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 20, Column 35: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript/officescript.emailattachment' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 21, Column 3: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 21, Column 35: [Suggestion: learn-site-link-broken - See documentation] Link '/officescript/officescript.emailattachment' points to a learn site page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 58cb8bf:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 8e6b25f:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 2aa74df:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

Learn Build status updates of commit b3cde6a:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit d6d503f:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit b9262fe:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ⚠️Warning View (office-scripts) Details
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

docs/docs-ref-autogen/preview-apis.md

  • Line 22, Column 7: [Warning: file-not-found - See documentation] Invalid file link: 'javascript/api/office-scripts/officescript'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 28218bc:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@alison-mk alison-mk marked this pull request as ready for review August 27, 2025 01:56
@alison-mk alison-mk requested a review from Copilot August 27, 2025 01:57
Copy link
Contributor

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 adds a comprehensive preview APIs documentation article for Office Scripts, following the pattern established by Excel JavaScript Preview APIs documentation. The article provides visibility into upcoming Office Scripts APIs before they reach general availability.

  • Adds a new "Preview APIs" section to the table of contents for easy discovery
  • Creates a detailed article documenting current preview APIs with feature summaries and comprehensive API listings
  • Focuses on PDF generation and email functionality as the primary preview features

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/docs-ref-autogen/toc.yml Adds Preview APIs navigation entry to the documentation structure
docs/docs-ref-autogen/preview-apis.md Complete preview APIs documentation with feature overview and detailed API reference table

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 86d6a6e:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Co-authored-by: jeremy-msft <50122882+jeremy-msft@users.noreply.github.com>
@learn-build-service-prod
Copy link

Learn Build status updates of commit f187cff:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/preview-apis.md ✅Succeeded View (office-scripts)
docs/docs-ref-autogen/toc.yml ✅Succeeded View (office-scripts)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@alison-mk alison-mk merged commit 3351ca0 into main Aug 27, 2025
2 checks passed
@alison-mk alison-mk deleted the alison-mk-preview-apis branch August 27, 2025 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants