Skip to content

Commit 9f6a577

Browse files
authored
chore: update doc generation instructions
1 parent 8436a05 commit 9f6a577

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

etc/docs/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,16 @@ main branch, and once the PR is merged Github will automatically update the host
4848

4949
If releasing a minor version from a branch other than main, follow theses steps:
5050

51-
- You should generate an commit the documentation to the branch that tracks that major
52-
- Example if `main` is tracking 7.x.x, there should be a `6.x` branch
53-
- `6.x` should have a commit for the generated docs merged for it's latest feature
51+
- As part of the release, generate and commit the documentation to the release branch
52+
- For example, if `main` is currently tracking `7.x` and your release is from `6.x`
53+
- `6.x` should contain the generated docs merged for its latest feature
5454
- Checkout a new branch off `main`
55-
- `git cherrypick` the commit containing the generated docs from the previous major
56-
- **There will be merge conflicts** (if there is no conflict there is an issue)
55+
- `git cherrypick` the commit containing the generated docs from the release
56+
- **There will be merge conflicts** (if there is no conflict, there is an issue)
5757
- Go through the conflicts:
5858
- undo the version increment change
5959
- undo the changes to history.md
6060
- merge together the feature version settings in the docs toml/json files
61-
- merge two table rows (`<tr>`) for the legacy minor and for the current major's minor
61+
- merge the two table rows (`<tr>`) for the legacy minor and the current major's minor
6262
- Check `npm run preview:docs`
63+
- Open a PR to merge the documentation into main

0 commit comments

Comments
 (0)