Reorganize includes folder#12757
Open
gewarren wants to merge 7 commits into
Open
Conversation
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-io-compression |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR contributes to dotnet/dotnet-api-docs issue #12513 by reorganizing reusable markdown content under includes/ and updating API XML docs to reference the reorganized includes (or inline the content), reducing reliance on the old includes/remarks/... layout.
Changes:
- Updated multiple XML docs to reference new include paths in
~/includes/*.md(and in several cases inlined previously-included remarks content directly into the XML). - Added new include fragments for
String.Format,WaitHandle exitContext, andPictureBoxremote-image load behavior. - Deleted a set of old include markdown files (primarily under
includes/remarks/System.IO.Compression/...) that are no longer referenced.
Reviewed changes
Copilot reviewed 23 out of 27 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System/String.xml | Updates provider-string-format include path to the reorganized includes/ root. |
| xml/System.Windows.Forms/PictureBox.xml | Updates include path for the “Load behavior changes” content. |
| xml/System.Threading/WaitHandle.xml | Updates include path for “Exit the context” content to a new root include. |
| xml/System.IO.Compression/ZipFileExtensions.xml | Replaces an include with inlined remarks content. |
| xml/System.IO.Compression/ZipFile.xml | Replaces includes with inlined remarks content for type and Open method. |
| xml/System.IO.Compression/ZipArchiveMode.xml | Replaces an include with inlined remarks content. |
| xml/System.IO.Compression/ZipArchiveEntry.xml | Replaces several includes with inlined remarks content. |
| xml/System.IO.Compression/ZipArchive.xml | Replaces includes with inlined remarks content (type + ctor remarks). |
| xml/System.IO.Compression/DeflateStream.xml | Replaces ctor remarks includes with inlined content and snippet references. |
| xml/System.IO.Compression/CompressionLevel.xml | Replaces an include with inlined remarks content. |
| includes/waithandle-exit-context.md | New include fragment for exitContext behavior explanation. |
| includes/simple-string-format.md | New include fragment intended for String.Format guidance. |
| includes/provider-string-format.md | New include fragment for provider-based String.Format guidance. |
| includes/picturebox-load-behavior-changes.md | New include fragment documenting .NET 8 PictureBox remote load behavior change. |
| includes/remarks/System.IO.Compression/ZipFileExtensions/ZipFileExtensions.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipFile/ZipFile.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipFile/Open.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchiveMode/ZipArchiveMode.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchiveEntry/ZipArchiveEntry.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchiveEntry/Name.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchiveEntry/LastWriteTime.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchiveEntry/FullName.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchive/ZipArchive.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/DeflateStream/.ctor_Stream_CompressionMode.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/DeflateStream/.ctor_Stream_CompressionLevel.md | Deleted (content moved/inlined). |
| includes/remarks/System.IO.Compression/CompressionLevel/CompressionLevel.md | Deleted (content moved/inlined). |
gewarren
commented
Jun 18, 2026
gewarren
requested review from
a team,
JeremyKuhne and
merriemcgaw
as code owners
BillWagner
approved these changes
Jun 19, 2026
BillWagner
left a comment
BillWagner
left a comment
Member
There was a problem hiding this comment.
This LGTM. You can 
when ready.
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
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.
Contributes to #12513.