Skip to content

Commit 6256ac0

Browse files
aviatcoAviat Cohen
andauthored
chore: update docs writer agent to build mkdocs (#259)
Co-authored-by: Aviat Cohen <aviatcohen@microsoft.com>
1 parent 6359031 commit 6256ac0

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

.github/agents/docs-writer.agent.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,13 +332,42 @@ Before delivering, determine whether the change affects other pages. Ask the use
332332

333333
Include cross-reference updates in your delivery — either as completed edits or as a list of recommended follow-up changes.
334334

335-
### 5. Deliver
335+
### 5. Build and preview locally
336+
337+
After editing documentation, build the site locally to catch broken links, invalid navigation entries, and formatting issues before delivery.
338+
339+
1. Install MkDocs with the Material theme and section index plugin:
340+
341+
```bash
342+
pip install mkdocs-material mkdocs-section-index
343+
```
344+
345+
2. Build the static site to validate the configuration:
346+
347+
```bash
348+
mkdocs build
349+
```
350+
351+
This creates a `site/` directory with the built documentation. Do not commit or push this directory — it is gitignored.
352+
353+
Run these commands from the repository root, where `mkdocs.yml` is located. Report any build warnings or errors and fix them before delivering.
354+
355+
**Do not run `mkdocs serve` yourself.** It starts a long-running development server that blocks the terminal until it is stopped, which stalls the task. Use `mkdocs build` for validation. Instead, hand off the preview command to the person updating the docs so they can run it interactively:
356+
357+
```bash
358+
mkdocs serve
359+
```
360+
361+
By default, the served site is available at `http://localhost:8000/fabric-cli`.
362+
363+
### 6. Deliver
336364

337365
Provide:
338366

339367
1. The documentation content.
340368
2. A one to three sentence note on which Fabric domains and terminology were relevant.
341369
3. A list of cross-reference impacts found in step 4, with recommended actions.
370+
4. Confirmation that the site builds cleanly with `mkdocs build` and a note on how to preview it with `mkdocs serve`.
342371

343372
---
344373

0 commit comments

Comments
 (0)