Skip to content

Update Userguide quick start docs with frontmatter and editorial improvements#355

Open
satyaog wants to merge 1 commit intomila-iqia:masterfrom
satyaog:hotfix/quickstart
Open

Update Userguide quick start docs with frontmatter and editorial improvements#355
satyaog wants to merge 1 commit intomila-iqia:masterfrom
satyaog:hotfix/quickstart

Conversation

@satyaog
Copy link
Copy Markdown
Member

@satyaog satyaog commented Mar 23, 2026

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

  • Added title and description frontmatter to Userguide_quick_start.md,
    Userguide_quick_start_my_first_job.md, and
    Userguide_quick_start_train_first_model.md.
  • Reformatted Key Concepts sections: switched from bullet lists to definition
    lists in the Quick Start and Train guides.
  • Converted a plain prerequisite note to a !!! success admonition with clearer
    checklist in the Quick Start guide.
  • Replaced a vague failure note with an !!! failure admonition for the SSH
    connection check.
  • Changed !!! note to !!! success for the VSCode prerequisite callout in the
    First Job guide.
  • Swapped bare - spacers for   in the First Job and Train guides.
  • Minor wording improvements throughout (passive voice reduction, line length,
    removed second-person "you will").

@satyaog satyaog requested a review from obilaniu as a code owner March 23, 2026 22:50
@satyaog satyaog force-pushed the hotfix/quickstart branch 3 times, most recently from 4a93e1f to a4df041 Compare March 24, 2026 16:45
@satyaog
Copy link
Copy Markdown
Member Author

satyaog commented Mar 24, 2026

The skills from #352 have been used to update these guides

@satyaog satyaog force-pushed the hotfix/quickstart branch 4 times, most recently from a9dd4ba to 7ffdcd9 Compare March 27, 2026 20:27
@satyaog satyaog force-pushed the hotfix/quickstart branch from 7ffdcd9 to 272cfd5 Compare March 27, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant