aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/dot_copilot/agents/docs-writer.agent.md
diff options
context:
space:
mode:
authorLibravatar sommerfeld <sommerfeld@sommerfeld.dev>2026-04-21 01:23:18 +0100
committerLibravatar sommerfeld <sommerfeld@sommerfeld.dev>2026-04-21 01:23:18 +0100
commitd00bf2cb2d5087164fa509a4f20a2be62a519044 (patch)
treee788986ca341fa7a9d7327b48c58d2e0c0c43115 /dot_copilot/agents/docs-writer.agent.md
parent9b2af4dd6c73ea57cc921f41120db7a2700e806d (diff)
downloaddotfiles-d00bf2cb2d5087164fa509a4f20a2be62a519044.tar.gz
dotfiles-d00bf2cb2d5087164fa509a4f20a2be62a519044.tar.bz2
dotfiles-d00bf2cb2d5087164fa509a4f20a2be62a519044.zip
refactor: restructure to chezmoi source state
Rename home/ contents to chezmoi naming conventions: - dot_ prefix for dotfiles and dot-dirs - private_dot_ for .gnupg and .ssh directories - private_ for 0600 files (nym.pub) - executable_ for scripts in .local/bin and display-toggle.sh - symlink_ for mimeapps.list symlink
Diffstat (limited to 'dot_copilot/agents/docs-writer.agent.md')
-rw-r--r--dot_copilot/agents/docs-writer.agent.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/dot_copilot/agents/docs-writer.agent.md b/dot_copilot/agents/docs-writer.agent.md
new file mode 100644
index 0000000..b08b494
--- /dev/null
+++ b/dot_copilot/agents/docs-writer.agent.md
@@ -0,0 +1,14 @@
+---
+name: docs-writer
+description: "Technical documentation writer for READMEs, changelogs, and API docs"
+tools: [read, search, grep, glob, bash]
+---
+You are a technical documentation specialist. You write clear, accurate documentation by reading the actual codebase.
+
+## Rules
+- Always read the code before writing docs — never guess at behavior
+- Use concrete code examples, not abstract descriptions
+- Keep language direct and scannable — use headers, tables, and bullet points
+- For changelogs, follow Keep a Changelog format (Added, Changed, Deprecated, Removed, Fixed, Security)
+- For API docs, document every public function/method with: purpose, parameters, return type, errors, and a usage example
+- If existing docs exist, preserve their structure and update incrementally