Skip to content

Commit

Permalink
📝 docs: Enhance README with project purpose and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
@thibaultyou
thibaultyou committed Oct 9, 2024
1 parent 7ae2ae5 commit f6bdeb0
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 74 deletions.
106 changes: 60 additions & 46 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,40 @@
>
> This project is evolving. You may encounter bugs or frequent changes. Your feedback and contributions are welcome!
Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse.
Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse. It is designed to be easily forked and customized for your own use, allowing you to create and maintain your personalized library of prompts tailored to your specific needs and use cases.

## 📂 Categories
## 🎯 Purpose

> **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit.
> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library.
### Coding
The primary goal of this project is to provide a structured framework for organizing and managing AI prompts. Whether you're a developer, researcher, or AI enthusiast, this library can help you:

- [Code Refactoring Agent](prompts/code_refactoring_agent/README.md) - Analyzes, refactors, and validates code to enhance quality, readability, and performance
- [Coding Assistant Agent](prompts/coding_assistant_agent/README.md) - Assists in all aspects of software development across multiple programming languages
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimal git branch names based on project context and development requirements
- [GitHub Issue Management Agent](prompts/github_issue_management_agent/README.md) - Creates comprehensive, optimized GitHub issues based on project context and team dynamics
- [Git Commit Message Expert](prompts/git_commit_message_agent/README.md) - Generates precise git commit messages following Conventional Commits specification
- [Software Development Pull Request Generator](prompts/software_dev_pr_generator/README.md) - Generates comprehensive pull requests for software projects based on given context

### Healthcare

- [Health Optimization Agent](prompts/health_optimization_agent/README.md) - Generates personalized, evidence-based health optimization plans using comprehensive data analysis

### Problem Solving
1. Store and categorize your prompts efficiently
2. Automatically generate metadata for your prompts
3. Easily navigate and reuse your prompt collection
4. Collaborate and share prompts with others

- [Problem Solving Goal Achievement Agent](prompts/problem_solving_goal_agent/README.md) - Generates tailored expert networks and solutions for complex challenges and ambitious goals
## 🛠️ How It Works

### Prompt Engineering
This repository uses a combination of user input and automated processes to manage your prompt library:

- [AI Assistant Concept Creator](prompts/ai_assistant_concept_creator/README.md) - Generates innovative and feasible AI assistant concepts for specific topics
- [Prompt Engineering Agent](prompts/prompt_engineering_agent/README.md) - Crafts and refines optimized prompts for AI models across various domains
- [Software Specification Creator](prompts/software_specification_agent/README.md) - Creates detailed software specifications through interactive review of user requirements
1. **Adding Prompts**: You create `prompt.md` files in the `prompts` directory to add new prompts to your library.

### Translation
2. **Version Control**: You commit and push your changes to the repository.

- [Universal Translator Agent](prompts/universal_translator_agent/README.md) - Translates between any languages, modes of expression, or conceptual frameworks
3. **Automated Processing**: Once changes are pushed, GitHub Actions are triggered automatically:
- The `generate_metadata.ts` script uses the Anthropic API to analyze your prompt and generate metadata.
- The `update_views.ts` script creates or updates the `README.md` files for each prompt and updates the main README.

### Writing
4. **Repository Updates**: All changes generated by the scripts are automatically committed back to the repository.

- [Software Documentation Specialist Agent](prompts/software_documentation_agent/README.md) - Creates comprehensive software documentation across various types and industries
You can monitor the progress of these automated processes in the "Actions" tab of your GitHub repository. This tab shows you the status of all workflow runs, allowing you to track the progress of your changes and troubleshoot any issues that may arise.

## 🚀 Getting Started

This repository is designed to be easily forked and customized for your own use. Follow these steps to get started:
To start building your own prompt library, follow these steps:

1. **Fork the Repository**: Click the "Fork" button at the top right of this page to create a copy of this repository in your own GitHub account.

2. **Clone Your Fork**: Clone the forked repository to your local machine using:

```
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
```
Expand All @@ -67,15 +54,16 @@ This repository is designed to be easily forked and customized for your own use.
5. **Add Your Own Prompts**:
- Create a new file in the `prompts` directory named `prompt.md`.
- Write your prompt content in this file.
- Commit and push your changes to GitHub.
- Commit and push your changes to GitHub:
```
git add .
git commit -m "Add new prompt: [Brief Description]"
git push
```
6. **Let GitHub Actions Work**:
- The GitHub Actions workflow will automatically generate metadata for your new prompt.
- It will create a new directory for your prompt, move the `prompt.md` file into it, and create `metadata.yml` and `README.md` files.
- The main README will be automatically updated to include your new prompt.
6. **Let GitHub Actions Work**: The automated processes will generate metadata and update README files.
7. **Run Locally**:
- Install dependencies by running `npm install` in the root directory of your project.
7. **Run Locally** (Optional):
- Copy the `.env.example` file to a new file named `.env` in the root directory of your project:
```
cp .env.example .env
Expand All @@ -86,10 +74,6 @@ This repository is designed to be easily forked and customized for your own use.
FORCE_REGENERATE=false
LOG_LEVEL=info
```
- Replace `your_actual_api_key_here` with your Anthropic API key.
- Set `FORCE_REGENERATE` to `true` if you want to force regeneration of metadata for all prompts.
- Adjust `LOG_LEVEL` as needed (`debug`, `info`, `warn`, or `error`).
- Ensure that `.env` is listed in your `.gitignore` file to prevent committing sensitive information.
- To generate metadata for your prompts, run:
```
npm run generate-metadata
Expand All @@ -103,12 +87,42 @@ This repository is designed to be easily forked and customized for your own use.
- Modify the templates in the `src/templates` directory to change how prompts are displayed.
- Update the scripts in `src/core` to alter the metadata generation or view update process.
## 🛠️ How It Works
## 📂 Prompt Library
> **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit.
- When you add or update a `prompt.md` file in the `prompts` directory, GitHub Actions are triggered.
- The `generate_metadata.ts` script uses the Anthropic API to analyze your prompt and generate metadata.
- The `update_views.ts` script creates or updates the `README.md` files for each prompt and updates the main README.
- All changes are automatically committed back to the repository.
> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library.
### Coding
- [Code Refactoring Agent](prompts/code_refactoring_agent/README.md) - Analyzes, refactors, and validates code to enhance quality, readability, and performance
- [Coding Assistant Agent](prompts/coding_assistant_agent/README.md) - Assists in all aspects of software development across multiple programming languages
- [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimal git branch names based on project context and development requirements
- [Git Commit Message Expert](prompts/git_commit_message_agent/README.md) - Generates precise git commit messages following Conventional Commits specification
- [GitHub Issue Management Agent](prompts/github_issue_management_agent/README.md) - Creates comprehensive, optimized GitHub issues based on project context and team dynamics
- [Software Development Pull Request Generator](prompts/software_dev_pr_generator/README.md) - Generates comprehensive pull requests for software projects based on given context
### Healthcare
- [Health Optimization Agent](prompts/health_optimization_agent/README.md) - Generates personalized, evidence-based health optimization plans using comprehensive data analysis
### Problem Solving
- [Problem Solving Goal Achievement Agent](prompts/problem_solving_goal_agent/README.md) - Generates tailored expert networks and solutions for complex challenges and ambitious goals
### Prompt Engineering
- [AI Assistant Concept Creator](prompts/ai_assistant_concept_creator/README.md) - Generates innovative and feasible AI assistant concepts for specific topics
- [Prompt Engineering Agent](prompts/prompt_engineering_agent/README.md) - Crafts and refines optimized prompts for AI models across various domains
- [Software Specification Creator](prompts/software_specification_agent/README.md) - Creates detailed software specifications through interactive review of user requirements
### Translation
- [Universal Translator Agent](prompts/universal_translator_agent/README.md) - Translates between any languages, modes of expression, or conceptual frameworks
### Writing
- [Software Documentation Specialist Agent](prompts/software_documentation_agent/README.md) - Creates comprehensive software documentation across various types and industries
## 🔧 Customizing Metadata Extraction
Expand Down
70 changes: 42 additions & 28 deletions src/templates/main_readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,40 @@
>
> This project is evolving. You may encounter bugs or frequent changes. Your feedback and contributions are welcome!
Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse.
Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse. It is designed to be easily forked and customized for your own use, allowing you to create and maintain your personalized library of prompts tailored to your specific needs and use cases.

## 📂 Categories
## 🎯 Purpose

> **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit.
The primary goal of this project is to provide a structured framework for organizing and managing AI prompts. Whether you're a developer, researcher, or AI enthusiast, this library can help you:

> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library.
1. Store and categorize your prompts efficiently
2. Automatically generate metadata for your prompts
3. Easily navigate and reuse your prompt collection
4. Collaborate and share prompts with others

{%- for category, prompts in categories %}
## 🛠️ How It Works

### {{ format_category(category) }}
This repository uses a combination of user input and automated processes to manage your prompt library:

{% for prompt in prompts %}
- [{{ prompt.title }}]({{ prompt.path }}) - {{ prompt.description }}
{%- endfor %}
{%- endfor %}
1. **Adding Prompts**: You create `prompt.md` files in the `prompts` directory to add new prompts to your library.

2. **Version Control**: You commit and push your changes to the repository.

3. **Automated Processing**: Once changes are pushed, GitHub Actions are triggered automatically:
- The `generate_metadata.ts` script uses the Anthropic API to analyze your prompt and generate metadata.
- The `update_views.ts` script creates or updates the `README.md` files for each prompt and updates the main README.

4. **Repository Updates**: All changes generated by the scripts are automatically committed back to the repository.

You can monitor the progress of these automated processes in the "Actions" tab of your GitHub repository. This tab shows you the status of all workflow runs, allowing you to track the progress of your changes and troubleshoot any issues that may arise.

## 🚀 Getting Started

This repository is designed to be easily forked and customized for your own use. Follow these steps to get started:
To start building your own prompt library, follow these steps:

1. **Fork the Repository**: Click the "Fork" button at the top right of this page to create a copy of this repository in your own GitHub account.

2. **Clone Your Fork**: Clone the forked repository to your local machine using:

```
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
```
Expand All @@ -45,15 +54,16 @@ This repository is designed to be easily forked and customized for your own use.
5. **Add Your Own Prompts**:
- Create a new file in the `prompts` directory named `prompt.md`.
- Write your prompt content in this file.
- Commit and push your changes to GitHub.
- Commit and push your changes to GitHub:
```
git add .
git commit -m "Add new prompt: [Brief Description]"
git push
```
6. **Let GitHub Actions Work**:
- The GitHub Actions workflow will automatically generate metadata for your new prompt.
- It will create a new directory for your prompt, move the `prompt.md` file into it, and create `metadata.yml` and `README.md` files.
- The main README will be automatically updated to include your new prompt.
6. **Let GitHub Actions Work**: The automated processes will generate metadata and update README files.
7. **Run Locally**:
- Install dependencies by running `npm install` in the root directory of your project.
7. **Run Locally** (Optional):
- Copy the `.env.example` file to a new file named `.env` in the root directory of your project:
```
cp .env.example .env
Expand All @@ -64,10 +74,6 @@ This repository is designed to be easily forked and customized for your own use.
FORCE_REGENERATE=false
LOG_LEVEL=info
```
- Replace `your_actual_api_key_here` with your Anthropic API key.
- Set `FORCE_REGENERATE` to `true` if you want to force regeneration of metadata for all prompts.
- Adjust `LOG_LEVEL` as needed (`debug`, `info`, `warn`, or `error`).
- Ensure that `.env` is listed in your `.gitignore` file to prevent committing sensitive information.
- To generate metadata for your prompts, run:
```
npm run generate-metadata
Expand All @@ -81,12 +87,20 @@ This repository is designed to be easily forked and customized for your own use.
- Modify the templates in the `src/templates` directory to change how prompts are displayed.
- Update the scripts in `src/core` to alter the metadata generation or view update process.
## 🛠️ How It Works
## 📂 Prompt Library
> **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit.
> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library.
{%- for category, prompts in categories %}
### {{ format_category(category) }}
- When you add or update a `prompt.md` file in the `prompts` directory, GitHub Actions are triggered.
- The `generate_metadata.ts` script uses the Anthropic API to analyze your prompt and generate metadata.
- The `update_views.ts` script creates or updates the `README.md` files for each prompt and updates the main README.
- All changes are automatically committed back to the repository.
{% for prompt in prompts %}
- [{{ prompt.title }}]({{ prompt.path }}) - {{ prompt.description }}
{%- endfor %}
{%- endfor %}
## 🔧 Customizing Metadata Extraction
Expand Down

0 comments on commit f6bdeb0

Please sign in to comment.