Update Userguide quick start docs with frontmatter and editorial improvements#355
Open
satyaog wants to merge 1 commit intomila-iqia:masterfrom
Open
Update Userguide quick start docs with frontmatter and editorial improvements#355satyaog wants to merge 1 commit intomila-iqia:masterfrom
satyaog wants to merge 1 commit intomila-iqia:masterfrom
Conversation
4a93e1f to
a4df041
Compare
Member
Author
|
The skills from #352 have been used to update these guides |
a9dd4ba to
7ffdcd9
Compare
7ffdcd9 to
272cfd5
Compare
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.
Summary
Adds YAML frontmatter (title + description) to the three Quick Start guide pages
and applies editorial polish throughout — clearer wording, minor restructuring,
and formatting fixes.
Changes
titleanddescriptionfrontmatter toUserguide_quick_start.md,Userguide_quick_start_my_first_job.md, andUserguide_quick_start_train_first_model.md.lists in the Quick Start and Train guides.
!!! successadmonition with clearerchecklist in the Quick Start guide.
!!! failureadmonition for the SSHconnection check.
!!! noteto!!! successfor the VSCode prerequisite callout in theFirst Job guide.
-spacers for in the First Job and Train guides.removed second-person "you will").