Improve docs around design-time builds #9594
Merged
Conversation
This file contains 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
Docs in this folder are aimed at users of the project system, so this change moves the most relevant customer-facing content forward in the doc, particularly now we are surfacing DTB errors more prominently in VS. This change adds the verbatim info bar text to the doc, so that searches can find it more easily. The instructions for capturing binlogs were refined to be more targeted and succinct. Instructions for earlier versions of VS were collapsed in a summary/details region. Outdated instructions for performance analysis have been rewritten to reference features in the structured log viewer. More explanation is given about what DTBs are used for, and what conditions trigger them. Newer GitHub markdown features were used. A previous edit made a section on authoring DTB targets confusing, by removing a table that it referenced. That table has been restored, and the content made clearer.
haileymck
reviewed
Nov 19, 2024
haileymck
reviewed
Nov 19, 2024
haileymck
reviewed
Nov 19, 2024
haileymck
reviewed
Nov 19, 2024
haileymck
approved these changes
Nov 19, 2024
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.
This PR updates
docs/design-time-builds.mdas it was missing some details, and had some outdated information. The content was rewritten in a few places to be clearer and provide more context.Docs in the
/docsfolder are aimed at users of the project system. This PR moves the most relevant customer-facing content to the front of the doc, particularly now we are surfacing DTB errors more prominently in VS.This change adds the verbatim info bar text to the doc, so that searches can find it more easily.
The instructions for capturing binlogs were refined to be more targeted and succinct. Instructions for earlier versions of VS were collapsed in a summary/details region.
Outdated instructions for performance analysis have been rewritten to reference features in the structured log viewer.
More explanation is given about what DTBs are used for, and what conditions trigger them.
Newer GitHub markdown features were used.
A previous edit (ace1a0e) made a section on authoring DTB targets confusing, by modifying a table that it referenced so a referenced column no longer existed. The old table has been copied into that section to avoid confusion and improve clarity.
Microsoft Reviewers: Open in CodeFlow