Skip to content

Reorganize SharePoint Embedded docs#10941

Open
marcwindle wants to merge 1 commit into
SharePoint:mainfrom
marcwindle:mawin-microsoft/sp-dev-docs-embedded-cleanup
Open

Reorganize SharePoint Embedded docs#10941
marcwindle wants to merge 1 commit into
SharePoint:mainfrom
marcwindle:mawin-microsoft/sp-dev-docs-embedded-cleanup

Conversation

@marcwindle

Copy link
Copy Markdown
Contributor

Summary

  • Reorganize SharePoint Embedded docs around the active task-based TOC and remove legacy orphaned pages with redirects.
  • Add admin guidance for creating SharePoint Embedded apps with PowerShell and developer guidance for using SharePoint Embedded as a Foundry knowledge source.
  • Normalize admin audience labels, terminology, Next steps, llms.txt, and the task-based SharePoint Embedded index.

Scope

  • Changes are limited to docs/embedded, docs/toc.yml, and .openpublishing.redirection.json.

Validation

  • Ran git diff --check and git diff --cached --check.
  • Checked embedded TOC hrefs, local Markdown/image links, live Learn Embedded TOC redirects, and unexpected embedded Markdown orphans.
  • Checked external URLs from TOC-backed Embedded docs.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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
Copy Markdown
Contributor

Learn Build status updates of commit 76dc45c:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/embedded/plan/app-tenant-architecture.md ⚠️Warning View Details
docs/embedded/sharepoint-embedded-documentation.md ⚠️Warning View Details
docs/toc.yml ⚠️Warning View Details
includes/snippets/spfx-gulp-heft-migration-wip.md ⚠️Warning View Details
.openpublishing.redirection.json 💡Suggestion View Details
docs/embedded/admin/setup-billing-m365-admin-center.md 💡Suggestion View Details
docs/embedded/build/configure-authentication-authorization.md 💡Suggestion View Details
docs/embedded/build/create-container-type.md 💡Suggestion View Details
docs/embedded/build/open-office-files.md 💡Suggestion View Details
docs/embedded/plan/container-types-and-containers.md 💡Suggestion View Details
docs/embedded/admin/admin-overview.md ✅Succeeded View
docs/embedded/admin/apply-security-compliance-controls.md ✅Succeeded View
docs/embedded/admin/consuming-tenant-admin.md ✅Succeeded View
docs/embedded/admin/create-apps-powershell.md ✅Succeeded View
docs/embedded/admin/create-apps-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/grant-admin-consent-permissions.md ✅Succeeded View
docs/embedded/admin/install-sharepoint-embedded-app.md ✅Succeeded View
docs/embedded/admin/manage-containers-powershell.md ✅Succeeded View
docs/embedded/admin/manage-containers-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/monitor-usage-billing-cost.md ✅Succeeded View
docs/embedded/admin/review-audit-events.md ✅Succeeded View
docs/embedded/administration/adminrole.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billing.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billingmanagement.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/meters.md ✅Succeeded n/a (file deleted or renamed)

This comment lists only the first 25 files in the pull request.

docs/embedded/plan/app-tenant-architecture.md

  • Line 96, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Container type registrations''. Each second level heading (H2) in an article must be unique.
  • Line 138, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Container type registrations''. Each second level heading (H2) in an article must be unique.

docs/embedded/sharepoint-embedded-documentation.md

  • Line 12, Column 145: [Warning: link-out-of-scope - See documentation] File 'embedded/llms.txt' referenced by link './llms.txt' will not be built because it is not included in build scope.
  • Line 103, Column 3: [Warning: link-out-of-scope - See documentation] File 'embedded/llms.txt' referenced by link './llms.txt' will not be built because it is not included in build scope.

docs/toc.yml

  • Line 434, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/office-ui-fabric-integration.md'.
  • Line 482, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.22.md'.
  • Line 486, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.21.md'.
  • Line 488, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.20.md'.
  • Line 490, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.19.md'.
  • Line 496, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.18.md'.
  • Line 506, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.17.md'.
  • Line 510, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.16.md'.
  • Line 514, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.15.md'.
  • Line 516, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.14.md'.
  • Line 520, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.13.md'.
  • Line 538, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.7.md'.
  • Line 540, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.6.md'.
  • Line 544, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.5.md'.
  • Line 548, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.4.md'.
  • Line 550, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.3.md'.
  • Line 552, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'spfx/release-1.1.md'.

includes/snippets/spfx-gulp-heft-migration-wip.md

  • Line 2, Column 89: [Warning: file-not-found - See documentation] Invalid file link: '../../docs/spfx/release-1.22.md'.

.openpublishing.redirection.json

  • [Suggestion: redirection-removed - See documentation] Redirection rule /sharepoint/dev/spfx/office-ui-fabric-integration defined in .openpublishing.redirection.json was deleted or changed. To avoid broken links, please don't remove the redirection rule.
  • [Suggestion: redirection-removed - See documentation] Redirection rule /sharepoint/dev/spfx/release-1.1 defined in .openpublishing.redirection.json was deleted or changed. To avoid broken links, please don't remove the redirection rule.
  • [Suggestion: redirection-removed - See documentation] Redirection rule /sharepoint/dev/spfx/release-1.13 defined in .openpublishing.redirection.json was deleted or changed. To avoid broken links, please don't remove the redirection rule.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
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.

@marcwindle marcwindle force-pushed the mawin-microsoft/sp-dev-docs-embedded-cleanup branch from 76dc45c to 8061f93 Compare July 11, 2026 02:15
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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
Copy Markdown
Contributor

Learn Build status updates of commit 8061f93:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/embedded/plan/app-tenant-architecture.md ⚠️Warning View Details
docs/embedded/sharepoint-embedded-documentation.md ⚠️Warning View Details
docs/embedded/admin/setup-billing-m365-admin-center.md 💡Suggestion View Details
docs/embedded/build/configure-authentication-authorization.md 💡Suggestion View Details
docs/embedded/build/create-container-type.md 💡Suggestion View Details
docs/embedded/build/open-office-files.md 💡Suggestion View Details
docs/embedded/plan/container-types-and-containers.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
docs/embedded/admin/admin-overview.md ✅Succeeded View
docs/embedded/admin/apply-security-compliance-controls.md ✅Succeeded View
docs/embedded/admin/consuming-tenant-admin.md ✅Succeeded View
docs/embedded/admin/create-apps-powershell.md ✅Succeeded View
docs/embedded/admin/create-apps-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/grant-admin-consent-permissions.md ✅Succeeded View
docs/embedded/admin/install-sharepoint-embedded-app.md ✅Succeeded View
docs/embedded/admin/manage-containers-powershell.md ✅Succeeded View
docs/embedded/admin/manage-containers-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/monitor-usage-billing-cost.md ✅Succeeded View
docs/embedded/admin/review-audit-events.md ✅Succeeded View
docs/embedded/administration/adminrole.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billing.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billingmanagement.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/meters.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/consuming-tenant-admin/cta.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/consuming-tenant-admin/ctapowershell.md ✅Succeeded n/a (file deleted or renamed)

This comment lists only the first 25 files in the pull request.

docs/embedded/plan/app-tenant-architecture.md

  • Line 96, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Container type registrations''. Each second level heading (H2) in an article must be unique.
  • Line 138, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Container type registrations''. Each second level heading (H2) in an article must be unique.

docs/embedded/sharepoint-embedded-documentation.md

  • Line 12, Column 145: [Warning: link-out-of-scope - See documentation] File 'embedded/llms.txt' referenced by link './llms.txt' will not be built because it is not included in build scope.
  • Line 103, Column 3: [Warning: link-out-of-scope - See documentation] File 'embedded/llms.txt' referenced by link './llms.txt' will not be built because it is not included in build scope.

docs/embedded/admin/setup-billing-m365-admin-center.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

docs/embedded/build/configure-authentication-authorization.md

  • Line 48, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
  • Line 106, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
  • Line 140, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/build/create-container-type.md

  • Line 28, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/build/open-office-files.md

  • Line 83, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/plan/container-types-and-containers.md

  • Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation] Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames.

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.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@marcwindle marcwindle force-pushed the mawin-microsoft/sp-dev-docs-embedded-cleanup branch from 8061f93 to de6d558 Compare July 11, 2026 02:23
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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
Copy Markdown
Contributor

Learn Build status updates of commit de6d558:

💡 Validation status: suggestions

File Status Preview URL Details
docs/embedded/admin/setup-billing-m365-admin-center.md 💡Suggestion View Details
docs/embedded/build/configure-authentication-authorization.md 💡Suggestion View Details
docs/embedded/build/create-container-type.md 💡Suggestion View Details
docs/embedded/build/open-office-files.md 💡Suggestion View Details
docs/embedded/plan/container-types-and-containers.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
docs/embedded/admin/admin-overview.md ✅Succeeded View
docs/embedded/admin/apply-security-compliance-controls.md ✅Succeeded View
docs/embedded/admin/consuming-tenant-admin.md ✅Succeeded View
docs/embedded/admin/create-apps-powershell.md ✅Succeeded View
docs/embedded/admin/create-apps-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/grant-admin-consent-permissions.md ✅Succeeded View
docs/embedded/admin/install-sharepoint-embedded-app.md ✅Succeeded View
docs/embedded/admin/manage-containers-powershell.md ✅Succeeded View
docs/embedded/admin/manage-containers-sharepoint-admin-center.md ✅Succeeded View
docs/embedded/admin/monitor-usage-billing-cost.md ✅Succeeded View
docs/embedded/admin/review-audit-events.md ✅Succeeded View
docs/embedded/administration/adminrole.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billing.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/billingmanagement.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/billing/meters.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/consuming-tenant-admin/cta.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/consuming-tenant-admin/ctapowershell.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/consuming-tenant-admin/ctaUX.md ✅Succeeded n/a (file deleted or renamed)
docs/embedded/administration/developer-admin/dev-admin.md ✅Succeeded n/a (file deleted or renamed)

This comment lists only the first 25 files in the pull request.

docs/embedded/admin/setup-billing-m365-admin-center.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

docs/embedded/build/configure-authentication-authorization.md

  • Line 48, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
  • Line 106, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
  • Line 140, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/build/create-container-type.md

  • Line 28, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/build/open-office-files.md

  • Line 83, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

docs/embedded/plan/container-types-and-containers.md

  • Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation] Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames.

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.

@andrewconnell andrewconnell self-assigned this Jul 12, 2026
@andrewconnell andrewconnell self-requested a review July 12, 2026 14:04
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.

2 participants