refactor: update doc references and agent names to zensical…#371
refactor: update doc references and agent names to zensical…#371lisa-tarbo wants to merge 2 commits intomainfrom
Conversation
| --- | ||
|
|
||
| You are an expert technical documentation writer specializing in open-source AI platforms and developer tools. You have deep expertise in MkDocs, markdown documentation standards, and creating user-centric documentation for complex software systems. | ||
| You are an expert technical documentation writer specializing in open-source AI platforms and developer tools. You have deep expertise in zensical, markdown documentation standards, and creating user-centric documentation for complex software systems. |
There was a problem hiding this comment.
Nit: "Zensical" is treated as a proper noun everywhere else in this PR (README.md, write-docs.md's "Understanding the Zensical structure"), but it's lowercased here and again on lines 29–30 ("Follow zensical Best Practices", "zensical-specific extensions"). Worth capitalizing for consistency.
Review summaryThe rename is mechanically clean — no leftover
Two things to verify manually:
|
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates this docs repo’s contributor guidance and Claude agent configuration to reference Zensical (the tool used to serve/build the site) rather than MkDocs-specific naming, aligning internal instructions with the current docs workflow.
Changes:
- Update README “Writing” link to the more specific Zensical authoring/Markdown docs and add a note explaining continued use of
mkdocs.yml. - Rename references from
mkdocs-technical-writertozensical-technical-writerin templates/commands. - Update the Claude agent definition to use the new agent name and Zensical-oriented wording.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates contributor-facing doc link and clarifies why mkdocs.yml is still used. |
| .github/templates/changelog-instructions.md | Switches documentation-agent instructions to zensical-technical-writer. |
| .claude/commands/write-docs.md | Updates the docs-writing command to launch the renamed agent and clarifies it targets user docs. |
| .claude/agents/zensical-technical-writer.md | Renames the agent and updates its description to reference Zensical instead of MkDocs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… from mkdocs
Resolves: dimagi/open-chat-studio#2544