Help Center article runbook
Use this for every create, update, and sunset of a Help Center article. Follow the Help Center section of the source doc. Leave Canny, Discord, in-app, and other launch-prep copy out of the article.Before editing
- Fetch the latest
mainand branch from it. - Name the branch
MMDD-short-topic(Lillianβs style). Lowercase letters, numbers, and hyphens only. Example:1026-mcp-tool-catalog. - Change only the articles named in the request. Do not add steps, screenshots, or tools the spec says to leave out.
Where articles live
The filename is the URL slug.
docs/article/auto-headline.mdx is /docs/article/auto-headline.
Create an article
- Add an MDX file with a
titlein the frontmatter.
- Put screenshots in
images/imgs/. Reference them from the article:
- Add the page path, without
.mdx, to the right nav group in bothmint.jsonanddocs.json. Keep the two files in the same order. - Link to other articles with site paths, such as
/docs/article/auto-headline.
Update an article
- Edit the existing MDX. Keep wording the spec says is already fine.
- When replacing a screenshot, use a new filename so browsers do not keep the old image. Delete the old file if nothing else references it.
- If a URL is going away, add a redirect. Do not leave the old page live.
Sunset an article
- Delete the MDX file.
- Add the same redirect to
mint.jsonanddocs.json:
- Delete images that only the retired page used.
- Leave the replacement article in place.
Writing rules
- The
styleprop is a JSX object with camelCase keys:style={{ width: '100%' }}. Never a string. - Images must be under 10MB. CI rejects anything larger, and it rejects a
srcthat points at a missing file. - Do not commit screenshots sitting in the repo root. Those are local leftovers.
Preview
Runnpm run dev from the repo root and open http://localhost:3333 plus the article path. Check the changed page before asking for a PR. Do not push until that review is approved.
Pull request
- One sentence on why, then a short point-form body. No extra commentary.
- Assign the reviewers named in the request.
- A merge to
mainpublishes the site.