Skip to content

Commit e81d6d1

Browse files
docs: Adding Docs Guidelines to Contibuting Guidelines (#1924)
* Adding Docs Guidelines to Contibuting Guidelines Signed-off-by: Sandi Besen <[email protected]> * Update CONTRIBUTING.md fixing heading markdown formatting Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Sandi Besen <[email protected]> * Update CONTRIBUTING.md changing to pnpm instead of npm to be consistent Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Sandi Besen <[email protected]> * Making suggested changes for brevity Signed-off-by: Sandi Besen <[email protected]> --------- Signed-off-by: Sandi Besen <[email protected]> Signed-off-by: Sandi Besen <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 301882b commit e81d6d1

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,17 @@ In addition to publishing the stable version, this action also ensures that the
302302

303303
## Documentation
304304

305-
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs/development` folder.
305+
There are two documentation folders: `docs/stable` and `docs/development`. Due to the nature of Mintlify, docs are deployed from the `main` branch, so we keep `docs/stable` frozen to correspond to the latest stable release. **Only make manual changes in `docs/stable` in order to fix issues with the docs, feature PRs should only edit `docs/development`.**
306306

307-
The documentation for the CLI is auto-generated. Run `mise run agentstack-cli:docs` to generate it.
307+
All PRs **must** either include corresponding documentation in `docs/development`, or include `[x] No Docs Needed` in the PR description. This is checked by GitHub Actions.
308308

309-
A GitHub workflow automatically checks that documentation requirements are met. If your change does not require documentation updates (e.g., bug fixes that don't change behavior, internal refactoring, or test-only changes), you must explicitly note this in your PR description.
309+
Special care needs to be taken with the `docs/development/reference/cli-reference.mdx` file, which is automatically generated. Use `mise run agentstack-cli:docs` to regenerate this file when modifying the CLI interface.
310+
311+
Try to follow this structure:
312+
313+
- **Elevator pitch:** What value this feature brings to the user.
314+
- **Pre-requisites:** Extra dependencies required on top of Agent Stack -- non-default agents, Docker runtime, 3rd party libraries, environment variables like API keys, etc. (Note that `uv` is part of the Agent Stack install.)
315+
- **Step-by-step instructions**
316+
- **Troubleshooting:** Common errors and solutions.
317+
318+
Make sure to preview docs locally using: `mise docs:run`. This runs a development server which refreshes as you make changes to the `.mdx` files.

0 commit comments

Comments
 (0)