Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Prompt Library with New Prompts and Improved Organization #9

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

thibaultyou
Copy link
Owner

Description

This pull request introduces several enhancements to the Prompt Library repository, improving its organization and expanding its content. The changes aim to make the library more user-friendly, comprehensive, and easier to maintain.

Key updates include:

  • Addition of new AI prompts for various domains (code documentation, software development, idea generation)
  • Improved organization of prompts by sorting categories alphabetically
  • Restructuring of the view template to prioritize important information
  • Updates to the README to reflect new prompts and categories

These changes will significantly enhance the utility of the Prompt Library, providing users with a wider range of AI prompts and improving the overall browsing experience.

Testing

  • The updated update_views.py script has been run locally to ensure proper generation of view files and README updates.
  • New prompts have been manually reviewed for consistency and quality.

Future Work

  • Consider implementing a tagging system for easier prompt discovery across categories.
  • Explore the possibility of adding a search functionality to the README or repository.

Changes

  1. .github/scripts/update_views.py:

    • Updated to sort categories alphabetically for consistent ordering in the README.
    • Minor code formatting improvements for readability.
  2. .github/templates/view_template.md:

    • Restructured to prioritize the one-line description and full description.
    • Moved tags to the bottom of the template for better focus on content.
  3. README.md:

    • Updated to reflect new prompts and categories.
    • Categories are now sorted alphabetically for easier navigation.
  4. New prompts added:

    • prompts/ai_code_repository_documentation_generator/
    • prompts/ai_software_development_assistant/
    • prompts/ai_topic_idea_generator/
    • prompts/code_refactoring_ai_assistant/
  5. Existing prompt views updated:

    • prompts/git_commit_message_writer/view.md
    • prompts/github_pull_request_generator/view.md
    • prompts/god_tier_assistant_generator/view.md
    • prompts/software_specification_generator/view.md

Documentation

The README.md file has been automatically updated to include the new prompts and reflect the reorganized categories. Each new prompt includes its own view.md file with detailed information about its purpose and usage.

@thibaultyou thibaultyou added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 29, 2024
@thibaultyou thibaultyou self-assigned this Sep 29, 2024
@thibaultyou thibaultyou merged commit e9a0c0c into main Sep 29, 2024
1 check passed
@thibaultyou thibaultyou deleted the feature/add-ai-dev-prompts branch September 30, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant