Skip to content

Commit

Permalink
📝 docs(readme): Add auto-generation for table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultyou committed Oct 10, 2024
1 parent a36c21c commit 1a3d209
Show file tree
Hide file tree
Showing 5 changed files with 999 additions and 678 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/update_views.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ jobs:
- name: Update views
run: npm run update-views

- name: Generate TOC
run: npm run toc

- name: Commit changes
run: |
git config --local user.name "github-actions[bot]"
Expand Down
63 changes: 35 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,19 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p

## 📚 Table of Contents

<!-- toc -->

- [🎯 Purpose](#%F0%9F%8E%AF-purpose)
- [🛠️ How It Works](#%F0%9F%9B%A0%EF%B8%8F-how-it-works)
- [📂 Prompt Library](#%F0%9F%93%82-prompt-library)
* [Coding](#coding)
* [Healthcare](#healthcare)
* [Problem Solving](#problem-solving)
* [Prompt Engineering](#prompt-engineering)
* [Translation](#translation)
* [Writing](#writing)
- [🚀 Getting Started](#%F0%9F%9A%80-getting-started)
- [🔧 Customizing Metadata Extraction](#%F0%9F%94%A7-customizing-metadata-extraction)
- [🧩 Using Fragments](#%F0%9F%A7%A9-using-fragments)
- [📝 Contributing](#%F0%9F%93%9D-contributing)
- [📄 License](#%F0%9F%93%84-license)

<!-- tocstop -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [🎯 Purpose](#-purpose)
- [🛠️ How It Works](#-how-it-works)
- [📂 Prompt Library](#-prompt-library)
- [🚀 Getting Started](#-getting-started)
- [🔧 Customizing Metadata Extraction](#-customizing-metadata-extraction)
- [🧩 Using Fragments](#-using-fragments)
- [📝 Contributing](#-contributing)
- [📄 License](#-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## 🎯 Purpose

Expand Down Expand Up @@ -58,38 +53,50 @@ You can monitor the progress of these automated processes in the "Actions" tab o
> **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.
<details>
<summary><strong>Coding</strong></summary>
### Coding

- [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
- [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
- [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
- [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
- [Software Specification Creator](prompts/software_spec_creator_agent/README.md) - Creates detailed software specification documents through interactive requirement analysis
- [Software Development Pull Request Generator](prompts/software_dev_pr_generator/README.md) - Generates comprehensive pull requests for software projects based on given context

### Healthcare
</details>
<details>
<summary><strong>Healthcare</strong></summary>

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

### Problem Solving
</details>
<details>
<summary><strong>Problem Solving</strong></summary>

- [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
</details>
<details>
<summary><strong>Prompt Engineering</strong></summary>

- [AI Assistant Architect](prompts/ai_assistant_architect/README.md) - Generates innovative and practical concepts for specialized AI assistants
- [Prompt Engineering God](prompts/prompt_engineering_agent/README.md) - Crafts and refines optimized prompts for AI models using advanced techniques and guidelines

### Translation
</details>
<details>
<summary><strong>Translation</strong></summary>

- [Universal Translator Agent](prompts/universal_translator_agent/README.md) - Translates between any languages, modes of expression, or conceptual frameworks

### Writing
</details>
<details>
<summary><strong>Writing</strong></summary>

- [Software Documentation Specialist Agent](prompts/software_documentation_agent/README.md) - Creates comprehensive software documentation across various types and industries

</details>

## 🚀 Getting Started

To start building your own prompt library, follow these steps:
Expand Down
Loading

0 comments on commit 1a3d209

Please sign in to comment.