Repository navigation
docs: tighten the tone of the new tutorial pages - #61
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #61 +/- ##
=======================================
Coverage 83.79% 83.79%
=======================================
Files 55 55
Lines 5640 5640
=======================================
Hits 4726 4726
Misses 914 914 🚀 New features to boost your workflow:
|
wenh06
force-pushed
the
docs-style-pass
branch
from
October 29, 2026 15:52
c410fdb to
471939c
Compare
Align the phrasing with the rest of the documentation: replace
journalistic formulations ("walks you through", "the accuracy story",
"the cast in one table", "buys two extra iterations", "kept honest")
with plain declarative sentences, use noun-phrase headings where the
drafts had questions or imperatives, and reword the zh_CN translations
to match, removing calques of the English constructions (e.g. literal
"come back", "all you need"). No technical content changes.
The workflow-level 'pages' concurrency group applied to every run, including pull-request builds that never reach the publish step. With cancel-in-progress, any newer run in the group (another pull request's docs build, or a deploy from master) cancelled older pending builds, so two docs-touching pull requests kept cancelling each other's checks. Deploy-capable runs (pushes to doc/master, manual dispatch) now share the 'pages-deploy' group, keeping real page publications mutually exclusive; each pull request gets its own 'docs-build-<number>' group.
wenh06
force-pushed
the
docs-style-pass
branch
from
October 29, 2026 17:18
6335a54 to
52a53f2
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
A language-style pass over the four tutorial pages already on master (
quickstart,concepts,tutorial-first-experiment,tutorial-cli-matrix) plustest-files/quickstart.py:Plus one CI fix:
docs-test-publish.yml: scope the concurrency group so that deploy-capable runs (pushes to doc/master, manual dispatch) share thepages-deploylock while each pull request gets its owndocs-build-<number>group. Previously every run shared onepagesgroup with cancel-in-progress, so pull-request docs builds kept cancelling each other (and being cancelled by master deploys) even though PR builds never reach the publish step.No technical content changes; all numbers, links and code blocks are unchanged.
Validation
pages-deployfor deploy runs anddocs-build-<number>for pull requests.