From dc88b1742c75b63576438442fd7b618a8526e530 Mon Sep 17 00:00:00 2001 From: Juniper Alanna <201364921+juniper-shopify@users.noreply.github.com> Date: Thu, 7 May 2026 15:47:45 -0400 Subject: [PATCH] Add subdir for comments-related internal documentation --- .claude/commands/docs/write-comments.md | 2 +- internal/documentation/{ => comments}/architectural-notes.md | 0 internal/documentation/{ => comments}/doc-comments-external.md | 0 internal/documentation/{ => comments}/doc-comments-internal.md | 0 internal/documentation/{ => comments}/doc-comments.md | 0 5 files changed, 1 insertion(+), 1 deletion(-) rename internal/documentation/{ => comments}/architectural-notes.md (100%) rename internal/documentation/{ => comments}/doc-comments-external.md (100%) rename internal/documentation/{ => comments}/doc-comments-internal.md (100%) rename internal/documentation/{ => comments}/doc-comments.md (100%) diff --git a/.claude/commands/docs/write-comments.md b/.claude/commands/docs/write-comments.md index 4769d8375..1e4d1d4dc 100644 --- a/.claude/commands/docs/write-comments.md +++ b/.claude/commands/docs/write-comments.md @@ -8,7 +8,7 @@ Accepts either: ## Task -Following the guidelines in `internal/documentation/`: +Following the guidelines in `internal/documentation/comments/`: 1. **Determine documentation type:** - For Config, Input, Output classes → Use `doc-comments-external.md` (user-facing, thorough) diff --git a/internal/documentation/architectural-notes.md b/internal/documentation/comments/architectural-notes.md similarity index 100% rename from internal/documentation/architectural-notes.md rename to internal/documentation/comments/architectural-notes.md diff --git a/internal/documentation/doc-comments-external.md b/internal/documentation/comments/doc-comments-external.md similarity index 100% rename from internal/documentation/doc-comments-external.md rename to internal/documentation/comments/doc-comments-external.md diff --git a/internal/documentation/doc-comments-internal.md b/internal/documentation/comments/doc-comments-internal.md similarity index 100% rename from internal/documentation/doc-comments-internal.md rename to internal/documentation/comments/doc-comments-internal.md diff --git a/internal/documentation/doc-comments.md b/internal/documentation/comments/doc-comments.md similarity index 100% rename from internal/documentation/doc-comments.md rename to internal/documentation/comments/doc-comments.md