Skip to content

docs: editorial improvements from user review pass#883

Open
dso-amd wants to merge 6 commits into
AMD-AGI:mainfrom
dso-amd:primus-bulk-edits
Open

docs: editorial improvements from user review pass#883
dso-amd wants to merge 6 commits into
AMD-AGI:mainfrom
dso-amd:primus-bulk-edits

Conversation

@dso-amd

@dso-amd dso-amd commented Jul 17, 2026

Copy link
Copy Markdown

Summary

Applies the subset of editorial changes from my earlier review pass (PR #866) that were not already incorporated into main by the final review pass (commit `4089c3a3`).

  • "WandB" → "Weights & Biases" in deployment.md and monitoring-logging.md
  • "whitelist" → "allowlist" in determinism-and-reproducibility, environment-variables, logging-and-experiment-tracking (inclusive language)
  • "HipBLASLt" → "hipBLASLt" in pretraining, troubleshooting, environment-variables section heading (correct product casing)
  • "sanity check/checks" → "validate"/"validation checks" in benchmarking and logging-and-experiment-tracking
  • "sanity check" → "smoke test" in adding-models
  • Slash "/" → "or"/"and" in training-recipes, cli-reference, parallelism-strategies, data-preparation, profiling-and-observability
  • "accelerator" → "GPU" in parallelism-strategies intro
  • "may" → "might" across 16 locations (style consistency)
  • monitoring-logging.md: heading and wording cleanup, structural subheading improvements
  • Misc sentence-level improvements in contributing.md, training-recipes.md, cli-reference.md, projection.md

Test plan

  • All modified files are Markdown documentation only — no code changes
  • Verify rendered output looks correct in the documentation site

🤖 Generated with Claude Code

Changes not already in main after the dev/production-doc squash merge:
- "WandB" → "Weights & Biases" in deployment.md and monitoring-logging.md
- "whitelist" → "allowlist" in determinism, env-vars, logging-and-experiment-tracking
- "HipBLASLt" → "hipBLASLt" in pretraining, troubleshooting, env-vars section heading
- "sanity check/checks" → "validate"/"validation checks" in benchmarking, logging-and-experiment-tracking
- "sanity check" → "smoke test" in adding-models
- Slash "/" → "or"/"and" in training-recipes, cli-reference, parallelism-strategies, data-preparation, profiling
- "accelerator" → "GPU" in parallelism-strategies intro
- "may" → "might" across 16 locations in various guides
- monitoring-logging.md: "Weights and Biases" → "Weights & Biases", structural heading
  cleanup (inline config file refs moved to separate lines), wording improvements
- contributing.md, training-recipes.md, cli-reference.md, projection.md: misc wording
  improvements and sentence restructuring from review pass

Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
wenxie-amd
wenxie-amd previously approved these changes Jul 17, 2026
Edits for better clarity and readability.
dso-amd added 4 commits July 17, 2026 11:11
Removed "Production" at the beginning.
Updated the in-file TOC
Updated User Guie TOC
@wenxie-amd
wenxie-amd requested a review from peterjunpark July 18, 2026 00:34
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.

3 participants