You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -307,18 +307,18 @@ In addition to publishing the stable version, this action also ensures that the
307
307
* **Storage Location:** All new or updated documentation files must be located in the `docs/development` folder. The `docs/stable` is only to be updated if changes are urgent and can't wait until the next release. Reasoning for changes made to `docs/stable` must be explicitly called out in your PR description.
308
308
* **Exemption Policy:** If a PR does not require documentation (e.g., internal refactoring, bug fixes with no API changes, or test updates), you must explicitly note this in your PR description: *"No documentation updates required."*
309
309
310
-
#### 2. Technical Validation & Automation
310
+
### 2. Technical Validation & Automation
311
311
* **Clean Environment Test:** Every code snippet must be verified from a **fresh install** of Agent Stack in a clean virtual environment to ensure all dependencies are correctly accounted for.
312
312
* **CLI Documentation:** Do not manually edit CLI reference pages. You must run the following command to ensure the reference stays in sync with the code:
313
313
`mise run agentstack-cli:docs`
314
314
* **CI/CD Integration:** A GitHub workflow automatically checks that documentation requirements are met. Ensure your build passes before requesting a review.
315
315
316
-
#### 3. Content & Experience Standards
316
+
### 3. Content & Experience Standards
317
317
* **Prerequisites:** Explicitly list any external dependencies (e.g., API keys, Docker, or Mise) needed to run the examples on that page.
318
318
* **Snippet Reliability:** Use `os.getenv` or the Agent Stack `secrets` utility for credentials—never hardcode strings or placeholders.
319
319
* **Structural Consistency:** Each page should include a brief explanation of the feature's value, a prerequisites block, step-by-step instructions, and a troubleshooting section for common errors.
320
320
321
-
#### Mintlify Preview for Live Changes
321
+
### Mintlify Preview for Live Changes
322
322
To verify the visual layout and formatting of your changes before submitting:
323
323
1. **Prerequisites:** Ensure you have **Node.js version 19 or higher**.
324
324
2. **Setup:** `cd` to the `docs` folder in the repo.
0 commit comments