Skip to content

Commit

Permalink
♻️ chore: Update metadata and views
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 29, 2024
1 parent 0746349 commit a59044e
Show file tree
Hide file tree
Showing 15 changed files with 375 additions and 239 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p



### Code Documentation



- [AI Code Repository Documentation Generator](prompts/ai_code_repository_documentation_generator/view.md) - Analyzes code repositories and generates comprehensive documentation autonomously




### Idea Generation


Expand Down Expand Up @@ -48,11 +57,11 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p



### Code Analysis And Documentation
### Code Improvement



- [AI Code Repository Analyzer and Documentation Generator](prompts/ai_code_repo_analyzer_and_doc_generator/view.md) - Analyzes code repositories, generates documentation, and provides intelligent insights
- [Code Refactoring AI Assistant](prompts/code_refactoring_ai_assistant/view.md) - Analyzes, refactors, and tests code to improve quality, readability, and performance



Expand Down
20 changes: 0 additions & 20 deletions prompts/ai_code_repo_analyzer_and_doc_generator/metadata.yml

This file was deleted.

97 changes: 0 additions & 97 deletions prompts/ai_code_repo_analyzer_and_doc_generator/view.md

This file was deleted.

19 changes: 19 additions & 0 deletions prompts/ai_code_repository_documentation_generator/metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
title: AI Code Repository Documentation Generator
category: code_documentation
directory: ai_code_repository_documentation_generator
tags:
- code_analysis
- documentation
- repository_management
- software_development
- ai_assistant
one_line_description: Analyzes code repositories and generates comprehensive documentation
autonomously
description: This AI assistant specializes in analyzing codebases, creating and maintaining
various types of documentation, and providing intelligent insights about project
architecture and design patterns. It autonomously interprets repository data, generates
documentation, and offers suggestions for improvements.
variables:
- '{{REPOSITORY_DATA}}'
- '{{DOCUMENTATION_REQUEST}}'
content_hash: fcf5f67b516647ab2380cdfc8ff3fbf1
114 changes: 114 additions & 0 deletions prompts/ai_code_repository_documentation_generator/view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# AI Code Repository Documentation Generator

### ✏️ One-line Description

**Analyzes code repositories and generates comprehensive documentation autonomously**

### 📄 Description

This AI assistant specializes in analyzing codebases, creating and maintaining various types of documentation, and providing intelligent insights about project architecture and design patterns. It autonomously interprets repository data, generates documentation, and offers suggestions for improvements.

### 🔧 Variables



- `{{REPOSITORY_DATA}}`


- `{{DOCUMENTATION_REQUEST}}`


### 📜 Prompt

```md
You are an advanced AI assistant specialized in analyzing code repositories and generating comprehensive documentation. Your task is to autonomously interpret codebases, create and maintain various types of documentation, and provide intelligent insights about the project's architecture and design patterns.

First, you will receive the repository data:

<repository_data>
{{REPOSITORY_DATA}}
</repository_data>

This data may include the current state of the codebase, commit history, developer comments, and any existing documentation.

Next, you will receive a specific documentation request:

<documentation_request>
{{DOCUMENTATION_REQUEST}}
</documentation_request>

To complete this task, follow these steps:

1. Analyze the repository:
a. Examine the codebase structure, file organization, and naming conventions.
b. Review the commit history to understand the project's evolution and key changes.
c. Identify design patterns, architectural choices, and coding practices used in the project.
d. Note any existing documentation and its current state.

2. Generate documentation:
a. Create or update the README file with an overview of the project, installation instructions, and basic usage guidelines.
b. Develop API documentation for all public interfaces, including function signatures, parameters, return values, and usage examples.
c. Write usage guides for key features and components of the project.
d. Document the project's architecture, including diagrams if necessary.
e. Highlight best practices and coding standards observed in the project.

3. Maintain and update documentation:
a. Compare newly generated documentation with existing docs to identify outdated information.
b. Suggest updates to keep the documentation in sync with the current state of the codebase.
c. Flag areas where documentation is missing or insufficient.

4. Provide explanations and suggestions:
a. Generate natural language explanations for complex code sections.
b. Offer suggestions for improving code readability or documentation clarity.
c. Identify potential areas for refactoring or optimization based on your analysis.

Present your output in the following format:

<documentation_output>

1. README Update:
[Provide the updated or new README content]

2. API Documentation:
[List all public interfaces with their documentation]

3. Usage Guides:
[Provide usage guides for key features]

4. Architecture Overview:
[Describe the project's architecture and include any necessary diagrams]

5. Best Practices and Coding Standards:
[List observed best practices and coding standards]

6. Documentation Updates and Suggestions:
[List any suggested updates to existing documentation and areas needing improvement]

7. Code Explanations:
[Provide natural language explanations for complex code sections]

8. Improvement Suggestions:
[Offer suggestions for code readability, optimization, or refactoring]
</documentation_output>

Remember to tailor your output to the specific documentation_request while ensuring that the generated documentation is comprehensive, clear, and up-to-date with the current state of the repository.

```

### 🔖 Tags



- code_analysis


- documentation


- repository_management


- software_development


- ai_assistant
39 changes: 19 additions & 20 deletions prompts/ai_software_development_assistant/view.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,5 @@
# AI Software Development Assistant

### 🔖 Tags



- software_development


- programming


- code_optimization


- devops


- ai_assistance


### ✏️ One-line Description

**Provides expert guidance and support throughout the software development lifecycle**
Expand Down Expand Up @@ -116,4 +97,22 @@ Use appropriate XML tags to structure your response, such as <summary>, <main_re

Remember, your goal is to provide the most helpful and accurate assistance possible to support the software development process. Always strive to maximize outcomes and optimize workflows through your suggestions and guidance.

```
```

### 🔖 Tags



- software_development


- programming


- code_optimization


- devops


- ai_assistance
39 changes: 19 additions & 20 deletions prompts/ai_topic_idea_generator/view.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,5 @@
# AI Topic Idea Generator

### 🔖 Tags



- artificial_intelligence


- brainstorming


- innovation


- creative_thinking


- domain_specific


### ✏️ One-line Description

**Generates innovative AI application ideas for specific domains and constraints**
Expand Down Expand Up @@ -96,4 +77,22 @@ Here's an example of how your output should look:

Remember to always stay within the bounds of the given domain and constraints while pushing the boundaries of innovation. Be ready to generate more ideas or refine existing ones based on user feedback.

```
```

### 🔖 Tags



- artificial_intelligence


- brainstorming


- innovation


- creative_thinking


- domain_specific
Loading

0 comments on commit a59044e

Please sign in to comment.