Skip to content

Commit 40cd59e

Browse files
committed
docs: include reference to rebuilding docs after a release
1 parent c4aa2f4 commit 40cd59e

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

.github/maintainers_guide.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ $ git push -u origin v1.2.3
6161
```
6262

6363
6. After merging these changes into `main` create a new [release](https://github.com/slackapi/slack-github-action/releases/new) with a new tag - `v1.2.3` - on publish. Include relevant changes in the release notes!
64-
7. Once released, make sure to close the relevant GitHub Milestone for the version you released.
64+
7. Rebuild [documentation](#docs) with the latest versions.
65+
8. Once released, make sure to close the relevant GitHub Milestone for the version you released.
6566

6667
## Workflow
6768

@@ -118,19 +119,19 @@ This repo contains two types of docs files:
118119

119120
The private repo containing the tools.slack.dev site pulls these in at build time.
120121

121-
Maintainers need to use the `run workflow` button associated with the `deploy` workflow in that private repo to update the docs with changes from here.
122+
Maintainers need to use the `run workflow` button associated with the `deploy` workflow in that private repo to update the docs with changes from here.
122123

123124
### Markdown Files
124125

125126
The markdown files here are secretly mdx files in disguise.
126127

127128
If you'd like to add images to pages, add the image files to the same folder the md file is in.
128129

129-
We appreciate markdown edits from anyone!!!
130+
We appreciate markdown edits from anyone!!!
130131

131132
### Sidebar
132133

133-
`_sidebar.json` sets the slack github action docs sidebar
134+
`_sidebar.json` sets the slack github action docs sidebar
134135

135136
sidebar values take the form of "slack-github-action/path-within-docs/"
136137

0 commit comments

Comments
 (0)