mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
44091f8e7b
* make changelog run earlier * add a bit of context to feature PRs * alphabetize * make vale audit less noisy
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
---
|
|
name: "Draft docs for new features"
|
|
on:
|
|
push:
|
|
- repo: "mintlify/server"
|
|
branch: main
|
|
- repo: "mintlify/mint"
|
|
branch: main
|
|
context:
|
|
- repo: "mintlify/docs"
|
|
automerge: false
|
|
---
|
|
|
|
Review the diff from the last merged PR in the triggering repository. Identify any new features, APIs, or other changes that require documentation.
|
|
|
|
For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant.
|
|
|
|
Success criteria: After reading any new or updated documentation, users understand what the feature is, if it applies to tasks they do, and how to use it.
|
|
|
|
## Important
|
|
|
|
- Only document changes that affect end users. Skip internal refactors or dependency updates.
|
|
- Match the style and structure of existing docs pages.
|
|
- If no user-facing changes were introduced, do nothing.
|
|
- Do not include private repository file paths, directory structures, code snippets, or any other internal implementation details in PR titles, descriptions, or commit messages.
|
|
- Write a quick summary of the feature that shipped in the PR description.
|