Skip to content

Add CLAUDE.md: Comprehensive AI assistant guide for repository#1

Open
usefia wants to merge 1 commit intodanielrosehill:mainfrom
usefia:claude/claude-md-ml431qfemv8g7b0w-3Aei6
Open

Add CLAUDE.md: Comprehensive AI assistant guide for repository#1
usefia wants to merge 1 commit intodanielrosehill:mainfrom
usefia:claude/claude-md-ml431qfemv8g7b0w-3Aei6

Conversation

@usefia
Copy link

@usefia usefia commented Feb 3, 2026

Summary

This PR adds CLAUDE.md, a comprehensive guide designed to help AI assistants (and human developers) understand and work effectively with the System-Prompt-Generation-Configurations repository. This document serves as a meta-guide for the meta-prompt engineering library.

Key Changes

  • Added CLAUDE.md with complete repository documentation including:
    • Repository overview and primary purpose
    • Detailed directory structure with descriptions of all 15+ categories
    • File format conventions for both Markdown and JSON
    • Naming conventions for files, directories, and prompts
    • Development workflows for adding, modifying, and organizing prompts
    • Automation script documentation (generate_index.py, generate_json.py)
    • Common tasks and bash commands for repository navigation
    • Key concepts and design principles
    • Code style guidelines for writing system prompts
    • Git workflow recommendations
    • Testing and integration notes

Notable Implementation Details

  • Structured as a reference guide with clear sections and tables for easy navigation
  • Includes practical examples (bash commands, JSON structure, markdown template)
  • Documents the automation infrastructure that keeps JSON and README synchronized
  • Explains the meta-nature of the repository (prompts that generate/edit other prompts)
  • Provides guidance on the dual-output design pattern (personal + open-source versions)
  • Covers security, localization, and multimodal capabilities
  • Designed to be accessible to both AI assistants and human contributors

Purpose

This guide enables AI assistants to:

  • Understand the repository's structure and purpose
  • Follow consistent conventions when contributing
  • Use the automation tools correctly
  • Understand the design principles behind the prompt library
  • Provide better assistance to users working with the repository

https://claude.ai/code/session_017YyV7H9XbFBYR41a58MyPf

This file documents the repository structure, conventions, and workflows
for AI assistants working with this system prompt library. Includes:
- Complete directory structure explanation
- File format conventions (Markdown and JSON)
- Development workflows for adding/modifying prompts
- Automation scripts documentation
- Code style guidelines for system prompts

https://claude.ai/code/session_017YyV7H9XbFBYR41a58MyPf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants