Skip to content

This framework works as a form of user/machine calibration, with a focus on user-context and user-intent, deconstructing your ideas logically from A to B to Z.

License

Notifications You must be signed in to change notification settings

vieGPT/scratchpad_fayeblade

Β 
Β 

Repository files navigation

The Scratchpad Framework

483854870-514bd1e1-6ef5-4403-8d0a-441881c5217e

Tests Coverage Bugs YAML License Python Code style: black PRs Welcome

Advanced AI Reasoning Templates for Comet Browser


Overview

The Scratchpad Framework is a curated collection of AI reasoning templates designed to transform how AI assistants think and respond. All frameworks are in clean YAML format, optimized for Comet Browser's character limits.

Repository Structure

scratchpad_fayeblade/
β”œβ”€β”€ frameworks/                 # AI reasoning framework templates
β”‚   β”œβ”€β”€ core/                  # 10 general-purpose reasoning templates
β”‚   β”œβ”€β”€ purpose-built/         # 18 task-specific frameworks
β”‚   └── personas/              # 8 AI assistant personalities
β”œβ”€β”€ scripts/                   # Utility and maintenance scripts
β”‚   β”œβ”€β”€ add_framework_metadata.py
β”‚   β”œβ”€β”€ add_yaml_doc_markers.py
β”‚   β”œβ”€β”€ convert_frameworks_to_proper_yaml.py
β”‚   β”œβ”€β”€ fix_all_yaml_compliance.py
β”‚   β”œβ”€β”€ fix_yaml_formatting.py
β”‚   β”œβ”€β”€ generate_framework_docs.py
β”‚   └── refactor_frameworks.py
β”œβ”€β”€ tests/                     # Comprehensive test suite (40 tests)
β”‚   β”œβ”€β”€ test_yaml_frameworks.py
β”‚   β”œβ”€β”€ test_scripts.py
β”‚   β”œβ”€β”€ test_bug_fixes.py
β”‚   └── test_edge_cases.py
β”œβ”€β”€ docs/                      # Extended documentation
β”‚   β”œβ”€β”€ ENHANCEMENT_SUMMARY.md
β”‚   β”œβ”€β”€ FRAMEWORK_COMPARISON.md
β”‚   β”œβ”€β”€ FRAMEWORK_REFERENCE.md
β”‚   β”œβ”€β”€ REMEDIAL_PLAYBOOK.md
β”‚   └── yaml-audit.md
β”œβ”€β”€ tools/                     # Development tools
β”‚   └── yaml-codex/           # YAML validation utilities
β”œβ”€β”€ schemas/                   # JSON schemas for validation
β”œβ”€β”€ CODEOWNERS                 # Code ownership definitions
β”œβ”€β”€ CONTRIBUTING.md            # Contribution guidelines
β”œβ”€β”€ README.md                  # This file
β”œβ”€β”€ requirements.txt           # Python dependencies
└── license.txt               # MIT License

Quick Start

Installation

  1. Clone the repository
git clone https://github.com/Fayeblade1488/scratchpad_fayeblade.git
cd scratchpad_fayeblade
  1. Install dependencies (for development and testing)
pip install -r requirements.txt

Using a Framework

  1. Browse the frameworks/ directory to find a suitable template
  2. Copy the YAML content from your chosen framework
  3. Paste it as a system prompt in Comet Browser or your AI assistant
  4. Start chatting and enjoy structured, transparent AI reasoning!

Example Usage

Using Scratchpad Lite for quick tasks:

# Copy content from frameworks/core/scratchpad-lite.yml
# Paste into Comet Browser's system prompt field
# Ask your question - the AI will now use structured reasoning

For research tasks:

# Use frameworks/purpose-built/deep-researcher.yml
# Perfect for academic research and literature reviews

Framework Categories

Core Frameworks (10)

  • scratchpad-lite.yml - Lightweight, 3-step reasoning
  • scratchpad-2.6.yml - Comprehensive 11-step analysis
  • scratchpad-2.5-refined.yml - Deep, multi-faceted reasoning
  • scratchpad-concise.yml - Short, to-the-point answers
  • scratchpad-think.yml - Metacognitive verbalization
  • Plus 5 more variants...

Purpose-Built Frameworks (18)

  • deep-researcher.yml - Research and investigation
  • game-design-gabg.yml - Game design planning
  • emotional-intelligence.yml - Emotion-aware responses
  • podsynth-clean.yml - Podcast script generation
  • Plus 14 more specialized frameworks...

Persona Frameworks (2)

  • gilfoyle-bot.yml - Systems architecture expertise (cynical tone)
  • anton-bot.yml - Browser automation specialist

Technical Details

File Format

  • Format: YAML 1.2.2 compliant
  • Encoding: UTF-8
  • Structure: Nested dictionaries with documented keys
  • Content Style: Literal block scalars (|) for long content

Framework Structure

Each framework YAML file contains:

name: "Framework Name"
version: "1.0"
category: "core|purpose-built|personas"
documentation:
  purpose: "Brief description of framework purpose"
  use_case: "Specific use cases and scenarios"
  character_count: 1234
framework:
  content: |
    The actual framework prompt content
    Uses literal block scalar for readability

Requirements

  • Python: 3.8+ (for development/testing)
  • Dependencies: PyYAML, pytest, coverage (see requirements.txt)
  • No runtime dependencies for using frameworks

Validation

  • YAML Syntax: 100% passing
  • Test Suite: 40 tests, all passing
  • Code Coverage: 59% for utility scripts
  • YAML Compliance: Full YAML 1.2.2 compliance

Testing

Run All Tests

# Run complete test suite
python -m pytest tests/

# Run with verbose output
python -m pytest tests/ -v

# Run with coverage report
python -m coverage run -m pytest tests/
python -m coverage report

Run Individual Test Suites

# YAML validation tests
python -m pytest tests/test_yaml_frameworks.py

# Script functionality tests
python -m pytest tests/test_scripts.py

# Bug fix validation tests
python -m pytest tests/test_bug_fixes.py

# Edge case tests
python -m pytest tests/test_edge_cases.py

Test Coverage

Current test coverage: 59% for scripts, 40 tests passing

Coverage includes:

  • YAML syntax validation
  • Framework structure verification
  • Script functionality testing
  • Edge case handling
  • Error recovery paths

Development

Repository Scripts

The scripts/ directory contains utility tools for framework maintenance:

  • fix_yaml_formatting.py - Ensures proper YAML formatting with literal block scalars
  • add_framework_metadata.py - Adds or updates framework metadata
  • generate_framework_docs.py - Auto-generates markdown documentation
  • refactor_frameworks.py - Converts legacy XML format to modern YAML
  • convert_frameworks_to_proper_yaml.py - Converts XML-embedded content to structured YAML
  • add_yaml_doc_markers.py - Adds YAML 1.2.2 document markers
  • fix_all_yaml_compliance.py - Comprehensive YAML compliance remediation

Running Scripts

# Fix YAML formatting
python scripts/fix_yaml_formatting.py

# Add missing metadata
python scripts/add_framework_metadata.py

# Generate documentation
python scripts/generate_framework_docs.py

Environment Variables

Scripts support the SCRATCHPAD_DIR environment variable:

export SCRATCHPAD_DIR=/path/to/repository
python scripts/fix_yaml_formatting.py

License

MIT License - Free for commercial and personal use.

See license.txt for full license text.

Contributing

We welcome contributions! Here's how you can help:

Reporting Issues

  • Use GitHub Issues for bug reports
  • Include framework name and error details
  • Provide example YAML content if relevant

Adding New Frameworks

  1. Create YAML file in appropriate category directory
  2. Follow the standard framework structure
  3. Include complete documentation metadata
  4. Test with pytest tests/
  5. Submit a Pull Request

Code Contributions

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes with tests
  4. Ensure all tests pass
  5. Submit a Pull Request

Documentation

  • Improvements to README or docs always welcome
  • Keep explanations clear and beginner-friendly
  • Include examples where helpful

Project Overview

  • 30 frameworks persona and framework rework
  • 70% file reduction (240 β†’ 73 files)
  • 19% size reduction (149MB β†’ 121MB)
  • 100% YAML validation passing

Credits and Mentions

Version 3.0 (October 2025) - Major refactoring and YAML conversion complete.

About

This framework works as a form of user/machine calibration, with a focus on user-context and user-intent, deconstructing your ideas logically from A to B to Z.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 72.7%
  • Shell 27.1%
  • Makefile 0.2%