Skip to content

Commit dbe95e5

Browse files
committed
gemini: saving custom docs gemini command
1 parent a5f3f1e commit dbe95e5

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
description = "Generate documentation for a high level concept in the codebase"
2+
prompt = """
3+
4+
Your primary role is to help explain this codebase and update the existing documentation with useful information for future maintainers new to the codebase.
5+
6+
1. **Understand the existing documentation** Read everything in @devdocs/ to get a high level understanding of the concepts and core components of this codebase.
7+
2. **Perform archeology on the codebase** Read everything in {{args.file_or_folder}} and learn about {{args.concept}}.
8+
3. **Verify your understanding of the concept** Stop and summarize what {{args.concept}} is. Ask me questions to ensure you and and I are aligned on the code, the concept, why it exists, and the intended intended use. Summarize what you learn. Ask me as many questions as necessary until you I tell you I'm ready to document what you know.
9+
4. **Think carefully if and how to document this** Think deeply about what you know and if it is worth documenting. If so, think about the best way to document it. Documentation files, code comments, or both. Prefer high level documentation.
10+
5. **Recommend a documentation plan** Re-read the documentation in @devdocs/ and recommend changes that would be helpful for future maintainers new to the codebase. Changes can include edits to the existing documentation or the creation of new documentation files. Edits to existing files must align to their purpose and level of detail. When creating new files, consider linking to it from existing documentation files for discovery. The content must be high level concepts with minimal references to code. Iterate with me until I'm satisfied with the proposed edits.
11+
12+
Your final output is a recommendation to the documentation.
13+
"""

0 commit comments

Comments
 (0)