Repository navigation
Overhaul Main Workflow Docs - #107415
Merged
Merged
Overhaul Main Workflow Docs#107415
Conversation
…xed a couple spelling and grammatical mistakes.
…ements one, and got far enough on the Windows requirements one.
…nd fixed a few broken links.
lambdageek
reviewed
Sep 5, 2024
lambdageek
left a comment
Member
There was a problem hiding this comment.
I think it's useful right off the bat to establish that for some workflows cross-compilation is the expected approach.
…oss-compiling to the general workflow introduction segment.
jkoritzinsky
reviewed
Sep 9, 2024
…/or outdated details.
lambdageek
reviewed
Sep 10, 2024
mikelle-rogers
left a comment
Member
There was a problem hiding this comment.
Thanks for putting this together!
…g to make the docs more friendly and clear as per received feedback.
5 tasks
steveisok
approved these changes
Sep 16, 2024
jtschuster
pushed a commit
to jtschuster/runtime
that referenced
this pull request
Sep 17, 2024
* Started the Quality Week work of improving the workflow docs. * Made more progress on the general workflow README doc, as well as the CoreCLR one. * Rephrased some things to make them roll off the tongue better, and fixed a couple spelling and grammatical mistakes. * Basically finished the main workflow README, and the CoreCLR building docs. * Almost done with the CoreCLR building docs, finished the MacOS requirements one, and got far enough on the Windows requirements one. * Finished the first pass on the Windows requirements doc. * Finished the first pass of the Linux Environment Requirements. * Finished the first pass of the Linux requirements doc. * Made good progress on the 'Using Docker' new doc. * Finished the first pass of the Using Docker doc. * Initial merging of the new docs with the existing documentation. * Improved the redaction of some sentences, improved some formatting, and fixed a few broken links. * Forgot to commit a NativeAOT note. * Removed the cross signs in the tables and added general info about cross-compiling to the general workflow introduction segment. * Added some redaction improvements, and corrected a few misleading and/or outdated details. * Linked the Workflow's README to the CoreCLR Building README. * Added a few additional details, and improved some wording and phrasing to make the docs more friendly and clear as per received feedback. * Fixed typo in the -DCLR_CMAKE_APPLE_DYSM=TRUE flags.
sirntar
pushed a commit
to sirntar/runtime
that referenced
this pull request
Sep 30, 2024
* Started the Quality Week work of improving the workflow docs. * Made more progress on the general workflow README doc, as well as the CoreCLR one. * Rephrased some things to make them roll off the tongue better, and fixed a couple spelling and grammatical mistakes. * Basically finished the main workflow README, and the CoreCLR building docs. * Almost done with the CoreCLR building docs, finished the MacOS requirements one, and got far enough on the Windows requirements one. * Finished the first pass on the Windows requirements doc. * Finished the first pass of the Linux Environment Requirements. * Finished the first pass of the Linux requirements doc. * Made good progress on the 'Using Docker' new doc. * Finished the first pass of the Using Docker doc. * Initial merging of the new docs with the existing documentation. * Improved the redaction of some sentences, improved some formatting, and fixed a few broken links. * Forgot to commit a NativeAOT note. * Removed the cross signs in the tables and added general info about cross-compiling to the general workflow introduction segment. * Added some redaction improvements, and corrected a few misleading and/or outdated details. * Linked the Workflow's README to the CoreCLR Building README. * Added a few additional details, and improved some wording and phrasing to make the docs more friendly and clear as per received feedback. * Fixed typo in the -DCLR_CMAKE_APPLE_DYSM=TRUE flags.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 aims to make the experience of the Workflow documentation of the runtime repo simpler and more accessible to the general public.
A summary of the changes made in this PR:
Ideas for follow-up work (in this PR and/or other subsequent PR's):