Update the postprocessor to build the Global namespace differently #384
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Learn Build status updates of commit aec1f4f: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
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 status updates of commit 760d3d5:
|
|
Learn Build status updates of commit de618ce: 💡 Validation status: suggestionsThis comment lists only the first 25 files in the pull request. docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
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. |
There was a problem hiding this comment.
Pull Request Overview
This PR restructures how the Global namespace docs are generated by moving and removing YAML files and updating configuration to point at the new locations.
- Adds a new
excelscript.cellcontrol.ymlunderdocs-ref-autogen/excelscript/ - Removes old Global OfficeScript enums, interfaces, and function docs from
docs-ref-autogen/excelscript.ymland theexcel/excelscriptfolder - Updates
docfx.jsonand.openpublishing.publish.config.jsonto reference the new autogen folder layout
Reviewed Changes
Copilot reviewed 6 out of 345 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/docs-ref-autogen/excelscript/excelscript.cellcontrol.yml | New CellControl type alias YAML moved into the updated folder |
| docs/docs-ref-autogen/excelscript.yml | Removed stale Global.OfficeScript enum, interface, and function refs |
| docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml | Deleted old EmailContentType enum file |
| docs/docfx.json | Adjusted src and files entries to include new YAML locations |
| .openpublishing.publish.config.json | Updated ReferenceTOC path to point at the relocated TOC file |
Comments suppressed due to low confidence (4)
docs/docs-ref-autogen/excelscript/excelscript.cellcontrol.yml:7
- [nitpick] The remarks field contains raw CRLF escape sequences; consider using a YAML block literal (
|or>-) to make the markdown links more readable and avoid escaped characters.
remarks: "\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol), [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol), [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol), [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)"
docs/docs-ref-autogen/excelscript.yml:152
- [nitpick] The nested list item uses
- -, which can make YAML parsing and maintenance confusing; verify that the enums list remains valid or flatten the list format.
- ExcelScript!ExcelScript.WorksheetPositionType:enum
.openpublishing.publish.config.json:57
- The TOC reference path was updated; please confirm that
docs/docs-ref-autogen/toc.ymlexists and is included in the repo to prevent broken navigation.
"ReferenceTOC": "docs/docs-ref-autogen/toc.yml",
| @@ -56,15 +56,17 @@ | |||
| "**/*.yml" | |||
| ], | |||
| "group": "office-scripts", | |||
| "src": "docs-ref-autogen/excel", | |||
| "src": "docs-ref-autogen", | |||
There was a problem hiding this comment.
[nitpick] Both docfx groups now target docs-ref-autogen and output to the same api/office-scripts; consider merging these sections or distinguishing them to avoid duplicate entries.
Copilot uses AI. Check for mistakes.
|
Learn Build status updates of commit de618ce: 💡 Validation status: suggestionsThis comment lists only the first 25 files in the pull request. docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
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 status updates of commit 957a724: 💡 Validation status: suggestionsThis comment lists only the first 25 files in the pull request. docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
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 status updates of commit 29843f8: 💡 Validation status: suggestionsThis comment lists only the first 25 files in the pull request. docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
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. |
|
@alison-mk, Looks like the redirects won't work unless I include the old file path in the build scope. That seems weird and opens things up to future errors, so I'd advise letting the current links 404 for now. |
alison-mk
approved these changes
Jul 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.