chore: update docs writer agent to build mkdocs#259
Merged
aviatco merged 1 commit intoJul 6, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the docs-writer agent workflow guidance to require a local MkDocs build validation step before delivering documentation changes, helping catch broken links/nav/config issues earlier.
Changes:
- Added a new “Build and preview locally” step with MkDocs install/build instructions.
- Clarified that
mkdocs buildis the validation step andmkdocs serveis for interactive preview by the docs author. - Updated the delivery checklist to require confirming a clean MkDocs build and providing preview instructions.
ayeshurun
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📥 Pull Request
✨ Description of new changes
This pull request updates the documentation workflow in
.github/agents/docs-writer.agent.mdto include a required local build and preview step before delivering documentation changes. The new instructions ensure documentation edits are validated for broken links, navigation issues, and formatting errors prior to delivery.Documentation workflow improvements:
mkdocs buildto validate documentation changes before delivery. This helps catch issues early and ensures the site builds cleanly.mkdocs serveshould not be run as part of the validation step, but should be used by the person updating the docs for interactive previewing.